Setup

Follow the instructions below to set up the application in your local environment.

Prerequisites

• Node.js
• npm (Node Package Manager)
• Git
• Docker

Steps to Set Up the Application

1. Fork the repository : Fork dev branch

2. Clone the repository :

   git clone https://github.com/pclubiitk/compass.git
   cd compass

3. Create a new branch from the dev branch

4. Create these keys :

   • Gmail app password
   • Site key and secret key for recaptcha
   • open ai moderation key.

5. Important environemnt setups (Use the respective templates provided in the respective folders) :

   • Create a .env file in root folder
   • create a .emv file in search folder
   • create a secret.yml file in server folder

use all the keys generated in 4 in these env and secret files

6. Some Dev bypass changes :

File	Bypass
server/middleware/underdev.go	make MapsUnderdev = false
Constant.ts	comment production backend url and uncomment development backend url
server/config.yml	change domain and frontend url also make env as dev
server/middleware/authenticator.go	make cookies secure false in dev environment
server/auth/handler.profile.go	comment the verify from oa checkpoint in uodate profile handler

7. Final commands to start everything :

   ## starting the map frontend
   npm install
   npm run dev
   
   ## starting the search frontend
   cd search
   npm install
   npm run build:worker
   npm run dev
   
   ## starting the backend
   cd ..
   cd server
   docker compose up --build

You can also run the full fronted using the docker compose file in the root folder. Just run the below command in the root folder and it will start both the frontend and backend together.