Skip to content

updating the docs to make it more accurate #757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

updating the docs to make it more accurate #757

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 9 additions & 15 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,45 +44,39 @@ If you are getting WSL error when you launch your desktop docker application, go

To get started with Code Racer locally, follow these steps

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was this removed? The project depends on docker.

1. Fork my repo

2. Fork the repo
2. Clone your fork

3. Clone your fork

```sh
git clone https://github.com/<YOUR_GITHUB_ACCOUNT_NAME>/code-racer.git
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure removing this is more clear than without it

```

4. Navigate to the project directory
3. Navigate to the project directory

```sh
cd code-racer
```

5. Create a .env file inside the project's packages/app directory.
4. Create a .env file inside the project's packages/app directory.

6. Copy and paste variables from `packages/app/.env.example` into `packages/app/.env`
5. Copy and paste variables from `packages/app/.env.example` into `packages/app/.env`

7. Install NPM packages
6. Install NPM packages

```sh
npm i
```

8. Start the Database
7. Start the Database

```sh
npm run dev:db
```

9. Start the app dev server
8. Start the app dev server

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

10. Start the web socket server
9. Start the web socket server

```sh
npm run dev:wss
Expand Down