Skip to content

Commit

Permalink
docs: Add Getting Started (#6)
Browse files Browse the repository at this point in the history
Co-authored-by: Sakamoto, Kazunori <[email protected]>
  • Loading branch information
ykit00 and exKAZUu authored Jan 9, 2024
1 parent 693fdbb commit 6130783
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,43 @@
[![Test](https://github.com/exKAZUu-Research/trace-dojo/actions/workflows/test.yml/badge.svg)](https://github.com/exKAZUu-Research/trace-dojo/actions/workflows/test.yml)

An educational web app for training program tracing skills.

## Getting Started

### Installation

1. Clone the repo

```
git clone [email protected]:exKAZUu-Research/trace-dojo.git
```

1. Install dependencies

```
yarn install
```

1. Reset local database by applying migration files and adding initial records

```
yarn db-reset
```

### Start Development

1. Start Next server

```
yarn start
```

### Change Database Schema

1. Change `prisma/schema.prisma`

1. Create migration files on the basis of `prisma/schema.prisma`

```
yarn db-migrate-create
```

0 comments on commit 6130783

Please sign in to comment.