Merge pull request #35 from icep0ps/Issue-#34-update-readme-file

Issue #34 Update readme file (WIP)

Author: webdevcody

README.md

@@ -16,57 +16,69 @@ Code Racer is a multiplayer coding game where developers can compete against eac
 - Tailwind CSS: A utility-first CSS framework for rapid UI development.
 - TypeScript: A typed superset of JavaScript that provides enhanced tooling and developer productivity.
 
-## Getting Started
+## Contribution
 
-To get started with Code Racer locally, follow these steps:
+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:
 
-    Clone the repository:
+- Fork the repository.
+- Create a new branch for your feature or bug fix.
+- Make your changes and test thoroughly.
+- Commit your changes with clear commit messages.
+- Push your branch to your forked repository.
+  Submit a pull request detailing your changes.
 
-```bash
-git clone https://github.com/webdevcody/code-racer.git
-```
+Please ensure that your code adheres to the project's coding standards and conventions.
 
-Navigate to the project directory:
 
-```bash
-cd code-racer
-```
+## Getting Started
 
-Install dependencies:
+### Prerequisites
 
-```bash
-npm install
-```
+You will need to [install docker](https://example.com) on your local machine.
 
-Updates schema to database
-```bash
-npx prisma db push
-```
+### Installation
 
-Start the development server:
+To get started with Code Racer locally, follow these steps
 
-```bash
-npm run dev
-```
+1. Clone the repo
+   ```sh
+    git clone https://github.com/webdevcody/code-racer.git
+   ```
+2. Navigate to the project directory
 
-Open your browser and visit http://localhost:3000 to see the application running.
+   ```sh
+   cd code-racer
+   ```
 
-## Configuration
+3. Install NPM packages
+   ```sh
+   npm install
+   ```
+4. Generate a version of Prisma Client that is tailored to the models.
+   ```js
+   npx prisma generate
+   ```
+5. Create .env file
 
-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:
+6. Copy and paste variables from `.env.example` into `.env`
 
-## Contribution
+7. Update each variable in `.env` (optional).
 
-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:
+8. Start a docker container for the database.
+   ```sh
+   docker compose up
+   ```
+9. Once your database is ready, push your prisma schema to the database.
+   ```sh
+   npx prisma db push
+   ```
+10. Finally start your dev server.
+    ```sh
+    npm run dev
+    ```
 
-- Fork the repository.
-- Create a new branch for your feature or bug fix.
-- Make your changes and test thoroughly.
-- Commit your changes with clear commit messages.
-- Push your branch to your forked repository.
-  Submit a pull request detailing your changes.
+Open your browser and visit http://localhost:3000 to see the application running.
 
-Please ensure that your code adheres to the project's coding standards and conventions.
 
 ## License