Skip to content

Commit 3ec0861

Browse files
authored
Merge pull request #36 from BrunchWithYou/updated-getting-started
#34 - Made changes to Prerequisites, Installation, and tidied up working on new feature part - LunchWithMe#2587
2 parents 0ad8a42 + d07c675 commit 3ec0861

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -33,22 +33,24 @@ Please ensure that your code adheres to the project's coding standards and conve
3333

3434
### Prerequisites
3535

36-
You will need to [install docker](https://example.com) on your local machine.
36+
You will need to [install docker](https://www.docker.com/get-started/) on your local machine.
37+
38+
If you do not have docker, go here to download and install: https://www.docker.com/get-started/
39+
40+
If you are getting WSL error when you launch your desktop docker application, go here and follow these steps for windows: https://learn.microsoft.com/en-us/windows/wsl/install-manual#step-4---download-the-linux-kernel-update-package.
3741

3842
### Installation
3943

4044
To get started with Code Racer locally, follow these steps
4145

4246
1. Fork my repo and clone your fork
4347
```sh
44-
git clone https://github.com/YOUR_USERNAME/code-racer.git
48+
git clone https://github.com/webdevcody/code-racer.git
4549
```
4650
2. Navigate to the project directory
47-
4851
```sh
4952
cd code-racer
5053
```
51-
5254
3. Install NPM packages
5355
```sh
5456
npm i
@@ -57,21 +59,19 @@ To get started with Code Racer locally, follow these steps
5759
```js
5860
npx prisma generate
5961
```
60-
5. Create .env file
62+
5. Create a .env file inside the project's root directory.
6163

6264
6. Copy and paste variables from `.env.example` into `.env`
6365

64-
7. Update each variable in `.env` (optional).
65-
66-
8. Start a docker container for the database.
66+
7. Open Docker Desktop Application and go back to your VSCode terminal and run this command:
6767
```sh
68-
docker compose up
68+
docker compose up -d
6969
```
70-
9. Once your database is ready, push your prisma schema to the database.
70+
8. Once your database is ready, push your prisma schema to the database.
7171
```sh
7272
npx prisma db push
7373
```
74-
10. Finally start your dev server.
74+
9. Finally start your dev server.
7575
```sh
7676
npm run dev
7777
```
@@ -84,13 +84,13 @@ Open your browser and visit http://localhost:3000 to see the application running
8484

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

87-
1. fork the repo
88-
2. clone your fork
89-
3. checkout a new branch
90-
4. do you work,
91-
5. commit
92-
6. push your branch to your fork
93-
7. go into github UI and create a PR from your fork & branch, and merge it into upstream MAIN
87+
1. Fork the repo
88+
2. Clone your fork
89+
3. Checkout a new branch
90+
4. Do your work
91+
5. Commit
92+
6. Push your branch to your fork
93+
7. Go into github UI and create a PR from your fork & branch, and merge it into upstream MAIN
9494

9595
### Pulling in changes from upstream
9696

0 commit comments

Comments
 (0)