Skip to content

Commit

Permalink
Merge branch 'main' into update-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TyrinH authored Jul 24, 2024
2 parents 2a6cb64 + 3d8920b commit 84b4a6f
Show file tree
Hide file tree
Showing 6 changed files with 216 additions and 190 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ To get started with Code Racer locally, follow these steps

1. Make sure you have installed Docker locally (See above Prerequisites)

2. Fork the repo
2. Fork the repository as your own repo

3. Clone your fork
3. Clone forked repo to your local machine

```sh
git clone https://github.com/<YOUR_GITHUB_ACCOUNT_NAME>/code-racer.git
Expand All @@ -69,25 +69,25 @@ To get started with Code Racer locally, follow these steps
```sh
npm i
```

8. Start the Database
If you are using Docker don't forget to run `docker-compose up` to start the database.
(Optional if using Docker for managing the database): Start the Database.

```sh
npm run dev:db
```
If you are using Docker don't forget to run `docker-compose up` to start the database.

9. Start the app dev server

```sh
npm run dev:app
```

10. Start the web socket server

```sh
npm run dev:wss
```

```sh
npm run dev:wss
```
Open your browser and visit <http://localhost:3000> to see the application running.

## Working on New Features
Expand All @@ -101,7 +101,7 @@ There is also a new video explaining how you can contribute to this project:

If you want to work on a new feature, follow these steps.

1. Fork the repo
1. Fork the repository
2. Clone your fork
3. Checkout a new branch
4. Do your work
Expand Down
78 changes: 59 additions & 19 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@
"devDependencies": {
"@flydotio/dockerfile": "^0.4.0",
"cross-env": "^7.0.3",
"husky": "^8.0.3"
"husky": "^8.0.3",
"prisma": "^5.12.0"
},
"dependencies": {
"@prisma/client": "^5.12.0"
}
}
Loading

0 comments on commit 84b4a6f

Please sign in to comment.