Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alisryan authored Sep 9, 2024
1 parent 0db2b8c commit 76b0311
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,21 @@ task install
```
This command will install dependencies for both frontend and backend.

### 3. Running the Application
### 3. Set up your .env
Create a .env in the root directory containing the following:

```
NODE_ENV=development
SERVER_PORT=3000
MONGO_URL=mongodb+srv://user:dbUserPassword@snappercluster.i3fur.mongodb.net/?retryWrites=true&w=majority&appName=SnapperCluster;
MONGO_USERNAME="user"
MONGO_PASSWORD="dbUserPassword"
SUPABASE_PASSWORD="9waZ2NQKum6FmP$"
SUPABASE_URL="https://xcgzrcnpyoxwxbjwnfnn.supabase.co"
SUPABASE_KEY="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6InhjZ3pyY25weW94d3hianduZm5uIiwicm9sZSI6ImFub24iLCJpYXQiOjE3MjU1NTMxOTUsImV4cCI6MjA0MTEyOTE5NX0.NgMdOTtSCbMdxkrzCgNYCyKBSLpzPuyARB8qnn3NKNo"
```

### 4. Running the Application
You can start the frontend and backend simultaneously by running:

```bash
Expand All @@ -62,22 +76,22 @@ task frontend:start
task backend:start
```

### 4. Running in Development Mode
### 5. Running in Development Mode
For development, where you may want auto-reload features:

```bash
task backend:dev
```

### 5. MongoDB with Docker
### 6. MongoDB with Docker
We are using Docker to run MongoDB locally. To start MongoDB, run:

```bash
docker-compose up
```
Mongo Express is available at http://localhost:3000 for database management.

### 6. Testing
### 7. Testing
To run the backend tests, use:

```bash
Expand Down

0 comments on commit 76b0311

Please sign in to comment.