Skip to content

Excel-MEC/excelplay-backend-service

Repository files navigation

Excel Play Backend

Excel Play is a series of online events held leading upto Govt. Model Engineering College's annual techno-managerial fest Excel.

Development

Running the project for development

Use docker-compose for running all components required for the project docker-compose up

To force a rebuild of the containers before starting them, use docker-compose up --build

To bring down all the containers and volumes that the command started, use docker-compose down --remove-orphans --volumes

All environment variables needed for docker can be found in .env file in the project root. PGAdmin can be used to manipulate the database manually and is available on localhost:5050 after running docker-compose. The login details can be found in the .env file and the IP of the postgres container that PGAdmin needs can be found by running docker inspect <postgres container name> | grep "IP". PGAdmin can also be configured to connect to a remote DB instead through it's UI, if a remote DB is being used instead a local DB.

To use endpoints that require auth access, create a JWT and pass it in the Authorization header in the format Bearer <token>. The sub field of the JWT must contain a valid uuid. This uuid must be that of a user already in the database.

For more documentation, see Excel Docs

Releases

No releases published

Packages

No packages published

Languages