Skip to content

Commit a398aa4

Browse files
committed
Issue #34 Update readme file (WIP)
1 parent fe54e87 commit a398aa4

File tree

1 file changed

+43
-33
lines changed

1 file changed

+43
-33
lines changed

README.md

+43-33
Original file line numberDiff line numberDiff line change
@@ -18,43 +18,53 @@ Code Racer is a multiplayer coding game where developers can compete against eac
1818

1919
## Getting Started
2020

21-
To get started with Code Racer locally, follow these steps:
22-
23-
Clone the repository:
24-
25-
```bash
26-
git clone https://github.com/webdevcody/code-racer.git
27-
```
28-
29-
Navigate to the project directory:
30-
31-
```bash
32-
cd code-racer
33-
```
34-
35-
Install dependencies:
36-
37-
```bash
38-
npm install
39-
```
40-
41-
Updates schema to database
42-
```bash
43-
npx prisma db push
44-
```
45-
46-
Start the development server:
47-
48-
```bash
21+
### Prerequisites
22+
23+
You will need to [install docker](https://example.com) on your local machine.
24+
25+
### Installation
26+
27+
To get started with Code Racer locally, follow these steps
28+
29+
1. Clone the repo
30+
```sh
31+
git clone https://github.com/webdevcody/code-racer.git
32+
```
33+
2. Navigate to the project directory
34+
35+
```sh
36+
cd code-racer
37+
```
38+
39+
3. Install NPM packages
40+
```sh
41+
npm install
42+
```
43+
4. Generate a version of Prisma Client that is tailored to the models.
44+
```js
45+
npx prisma generate
46+
```
47+
5. Create .env file
48+
49+
6. Copy and paste variables from `.env.example` into `.env`
50+
51+
7. Update each variable in `.env` (optional).
52+
53+
8. Start a docker container for the database.
54+
```sh
55+
docker compose up
56+
```
57+
9. Once your database is ready, push your prisma schema to the database.
58+
```sh
59+
npx prisma db push
60+
```
61+
10. Finally start your dev server.
62+
```sh
4963
npm run dev
50-
```
64+
```
5165

5266
Open your browser and visit http://localhost:3000 to see the application running.
5367

54-
## Configuration
55-
56-
Code Racer requires some configuration variables to run properly. Create a .env.local file in the root directory of the project and add the following variables:
57-
5868
## Contribution
5969

6070
We welcome contributions from the community! If you'd like to contribute to Code Racer, please follow refer to [CONTRIBUTION.md](CONTRIBUTION.md), but we have these base guidelines:

0 commit comments

Comments
 (0)