From e5351f26bd689a7dedd3b39cdb1a73a57df42664 Mon Sep 17 00:00:00 2001 From: tungnguyen267 Date: Mon, 3 Jun 2024 17:05:35 -0500 Subject: [PATCH] updating the docs to make it more accurate --- CONTRIBUTING.md | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4074ef36..dd222778 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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) +1. Fork my repo -2. Fork the repo +2. Clone your fork -3. Clone your fork - - ```sh - git clone https://github.com//code-racer.git - ``` - -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