CONTRIBUTING.md

Contributing

• Issues
• Development Guide
  • Local Setup
  • Docker Setup
• Pull Requests

Issues

If you notice any bugs or features that can be added, please open an issue! If you'd like to work on an issue, please assign yourself to it.

Development

⚙ Setup Without Docker

Client

• cd client
• npm install to install all dependencies
• npm start to build & start the React app

Server

• cd server
• npm install in the root directory to install all dependencies
• npm start to start the Node.js server

Database

• Install PostgreSQL 12.4 (untick pgAdmin installation, we'll install this separately) https://www.enterprisedb.com/downloads/postgres-postgresql-downloads
• pgAdmin version 4.27 release https://www.pgadmin.org/download/
• open pgAdmin -> PostgreSQL 12 -> Databases
• Right click Databases and Create -> Database
• name:'postgres', owner: 'postgres', password: 123456 (This is the current hard coded config defined in server file)
• Define LOCAL_USER LOCAL_DB LOCAL_PASSWORD LOCAL_HOST and LOCAL_PORT according to your server configs in .env
• In /server/src/database/db.ts, change Pool(config) on line 13 to Pool(localconfig)
• No errors should pop up if setup correctly.

🐳 Setup With Docker Compose

Server

• Make sure that you have .env file on the root directory of server (ask one of us!). This file defines DB_DATABASE, DB_PASSWORD, DB_USER, DB_PORT, and DB_HOST
• npm install in the root directory of server to install all dependencies
• run docker-compose up

Useful Docker Compose Commands (more found here)

• docker-compose up builds, (re)creates, starts, and attaches to containers for a service
• docker-compose build --no-cache does not use cache when building the image
• docker-compose ps lists containers
• docker-compose rm removes stopped service containers

Docker Installation For Windows

• WSL2 install Windows 10 https://docs.microsoft.com/en-us/windows/wsl/install-win10
• Docker Windows https://docs.docker.com/docker-for-windows/wsl/

Pull Requests

Before making a pull request, please ensure the following:

1. Your branch is up-to-date with the main branch
   • If it is out-of-date, please run git pull on your working branch
2. All checks pass (currently this is a linting check)
3. Your pull request changes under 1000 lines (recommended)
4. Your pull request has been reviewed by at least one other person.