Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

58 lines (38 loc) · 1.33 KB
Raw

Contribution guidelines

Pre-requisites

Assuming that Node.js is already installed.

  • MongoDB : NoSQL database
  • Mongosh : MongoDB shell
  • Pnpm : Package manager (optional but recommended)

Setup

  1. Install the dependencies.

This will install all the dependencies for both the backend and the frontend

pnpm install:all
  1. Make sure your MongoDB server is running.

This is for linux systems only. For windows, please refer to the official documentation.

# Start the server
sudo systemctl start mongod

# Check the status
sudo systemctl status mongod
  1. Seed the database with test data.

You can find the initial seed data in backend/scripts/test-data.json.
If needed you can also modify this file to add more data for testing purposes.

pnpm backend:seed
  1. Start the application.

This will start both the backend and the frontend servers in development mode concurrently.

pnpm start:dev

If you want to start the backend and the frontend servers separately, you can use the following commands.

# Start the backend server
pnpm backend:dev

# Start the frontend server
pnpm frontend:dev