Clubs Council IIITH Web

Dependencies

• Docker
• Docker Compose

Setup (Dev Environment)

Clone the main repository:

git clone https://github.com/Clubs-Council-IIITH/server.git clubs_council

Inside it, clone the application repositories:

cd clubs_council
git clone https://github.com/Clubs-Council-IIITH/backend.git
git clone https://github.com/Clubs-Council-IIITH/frontend.git

Copy .env file:

cp .env.example .env

Build and spin up all services (-d to run in detached mode):

docker compose up --build -d

By default, the ReactJS app (with hot reload) is served at http://localhost:3000, while the GraphQL API is served at http://localhost:8000.

To stop all running services belonging to this application (-v to remove all volumes):

docker compose down -v

Deployment (Prod Environment)

Make sure reverse proxy server is running (for SSL certs and subdomain routing).

Build and spin up all services (-d to run in detached mode):

docker compose -f docker-compose.prod.yml up --build -d

Troubleshooting and Gotchas

• On the dev environment, the backend and frontend services are run as the user with UID=1000 and GID=1000 (first unprivileged user on the system) to ensure that files created from within the containers on the mounted volumes are accessible by the host user. To run these services as a different user, spin the services up using UID=<uid> GID=<gid> docker compose up --build.