fix: update documentation, add local development setup, update usage and contributing guidelines

Author: Alexandrbig1

CONTRIBUTING.md

@@ -12,6 +12,34 @@ We welcome contributions of all skill levels.
 
 ---
 
+## Local Setup Steps
+
+1. **Set up your own MongoDB database**
+  - Use MongoDB Atlas (free tier) or run MongoDB locally.
+2. **Copy environment variables**
+  - Copy `.env.example` to `.env`:
+    ```bash
+    cp .env.example .env
+    ```
+  - Fill in your own values for `MONGODB_URI` and other variables in `.env`.
+3. **Seed the database**
+  - Run the seed script to populate your local database with sample data:
+    ```bash
+    npm run seed
+    ```
+4. **Start the development server**
+  - Run:
+    ```bash
+    npm run dev
+    ```
+5. **Lint your code before committing**
+  - Run:
+    ```bash
+    npm run lint
+    ```
+
+---
+
 ## Before You Start
 - Please read our [Code of Conduct](./CODE_OF_CONDUCT.md)  
 - Review our [Usage Guide](./docs/usage.md) to set up the backend locally  

README.md

@@ -74,6 +74,7 @@ New contributors can help with APIs, database models, and documentation.
 ---
 
 
+
 ## Quick Start
 
 See the [Usage Guide](docs/usage.md) for full setup.
@@ -96,6 +97,38 @@ npm run dev
 
 ---
 
+## Local Development Setup
+
+To work on this project locally, follow these steps:
+
+1. **Set up your own MongoDB database**
+  - You can use [MongoDB Atlas](https://www.mongodb.com/atlas/database) (free tier) or run MongoDB locally.
+2. **Copy environment variables**
+  - Copy `.env.example` to `.env`:
+    ```bash
+    cp .env.example .env
+    ```
+  - Fill in your own values for `MONGODB_URI` and other variables in `.env`.
+3. **Seed the database**
+  - Run the seed script to populate your local database with sample data:
+    ```bash
+    npm run seed
+    ```
+4. **Start the development server**
+  - Run:
+    ```bash
+    npm run dev
+    ```
+5. **Lint your code before committing**
+  - Run:
+    ```bash
+    npm run lint
+    ```
+6. **Ready to contribute!**
+  - Pick an issue, create a branch, and start coding.
+
+---
+
 ## Features
 
 - Simple **Express.js backend** ready to extend
@@ -136,22 +169,25 @@ Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on how to
 
 ---
 
+
 ## Hacktoberfest Contribution Guide
 
 1. Fork this repository
-2. Check our [Project Board](https://github.com/orgs/OpenCodeChicago/projects/2)  
-   - Look for an issue you’d like to work on  
-   - Comment on the issue to let others know you’re taking it  
-   - Maintainers may assign you to it (to avoid duplicates)
+2. Check our [Project Board](https://github.com/orgs/OpenCodeChicago/projects/2)
+  - Look for an issue you’d like to work on
+  - Comment on the issue to let others know you’re taking it
+  - Maintainers may assign you to it (to avoid duplicates)
 3. Create a new branch:
-   ```bash
-   git checkout -b my-new-feature
-   ```
-4. Make your changes (small, clear commits)
-5. Run `npm run lint` before pushing
-6. Open a Pull Request
-   - All PRs are automatically checked for linting in CI
-   - Tip: Start with [Good First Issues](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/labels/good%20first%20issue)
+  ```bash
+  git checkout -b my-new-feature
+  ```
+4. Set up your local environment (see above)
+  - Make sure your `.env` is configured and your database is seeded
+5. Make your changes (small, clear commits)
+6. Run `npm run lint` before pushing
+7. Open a Pull Request
+  - All PRs are automatically checked for linting in CI
+  - Tip: Start with [Good First Issues](https://github.com/OpenCodeChicago/hacktoberfest-2025-backend/labels/good%20first%20issue)
 
 ---
 

docs/usage.md

@@ -24,15 +24,25 @@ This document explains how to set up and run the backend locally.
    npm install
    ```
 3. **Set up environment variables**
-   Create a `.env` file in the project root:
+   Copy `.env.example` to `.env`:
+   ```bash
+   cp .env.example .env
+   ```
+   Edit `.env` and fill in your own values for `MONGODB_URI` and other variables.
+   Example:
    ```bash
    PORT=5000
    # Local MongoDB
    MONGODB_URI=mongodb://localhost:27017/hacktoberfest
    # or MongoDB Atlas
    # MONGODB_URI=mongodb+srv://<user>:<password>@cluster.mongodb.net/hacktoberfest
    ```
-4. **Start the server**
+4. **Seed the database**
+   Run the seed script to populate your local database with sample data:
+   ```bash
+   npm run seed
+   ```
+5. **Start the server**
    ```bash
    npm run dev
    ```