Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Jai-Marothiya authored Sep 29, 2024
1 parent ed9a286 commit 9fe4ba3
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,36 @@ To set up the project on your local machine, follow these steps:
npm install
```

## Local Environment Setup
Both the client and server folders require a .env file for environment-specific configurations. Below are the instructions for setting up these files.

### Server Folder (.env)
You must create a .env file in the server folder to store environment variables. Use the following template to set up your .env file:
```bash
# Server Configuration
PORT=5000

# PostgreSQL Database
DATABASE_URL=postgres://postgres:${your_pg_password}@127.0.0.1/algohub
PG_HOST="127.0.0.1"
PG_USER="postgres"
PG_PASSWORD= # Add your PostgreSQL password here
PG_DATABASE=algohub

# Google OAuth Credentials
CLIENT_ID=1088957184358-6vg9gfngftpc85443sb1e55v4m1l4cb6.apps.googleusercontent.com

# JWT Access Key
REFRESH_SECRET_KEY=f74b5b600a2b67c4f0ed42d65bf7a14dd394fd527bb65eaf5730ac2098e6d7e2dc51e278f0235ad9f8a1cb4b6e9efddc6e348b92d6c6e771aca0ef3b4e6fcab3
```

### Client Folder (.env)
You must create a .env file in the client folder to store environment variables. Use the following template to set up your .env file:
```bash
# Google auth Ceredentials
REACT_APP_CLIENT_ID=1088957184358-6vg9gfngftpc85443sb1e55v4m1l4cb6.apps.googleusercontent.com
```

## Run the project

1. **Start the backend server**:
Expand Down

0 comments on commit 9fe4ba3

Please sign in to comment.