- Website: https://club-catalyst.vercel.app/
- Demo-Video: https://drive.google.com/file/d/1NlSutKyRI6fwRbvqWWEgu6d0DTzbk9fO/view?usp=drive_link
This platform is designed to streamline the approval process for events and purchases within the student gymkhana office. It facilitates a structured workflow for approval automation, request generation, and data management.
- Requests go through a predefined procedure involving club generation, secretary recommendation, club financial advisor (FA) approval, society FA recommendation, and chairSAP approval.
- Purchase requests have additional rules based on the amount, with different approval chains and monthly limits.
- Clubs can submit requests with explanations and attachments.
- Requests include monetary aspects, which determine the approval chain.
- The portal supports text and attachments similar to an email.
To get started with the project locally, follow the steps below:
git clone https://github.com/Rudra-IITM/club_catalyst
If you prefer using Docker for managing the project environment, follow these instructions:
- Navigate to the project directory:
cd club_catalyst
-
Ensure that Docker is installed on your system and the Docker daemon is running.
-
Run the following command to start the project using Docker:
docker-compose up -d # To run in detached terminal
Go to the project directory
cd club_catalyst
Go to the backend directory
cd backend
Install dependencies
npm install
Setup environment variables
# copy .env.example to .env and set desired MONGO_URI (Mongo DB connection string)
cp .env.example .env
Run backend
npm run dev
Go to the frontend directory
cd frontend
Install dependencies
npm install
Setup environment variables
# copy .env.example to .env
cp .env.example .env
Run frontend
npm start
Once the project is running, you can access the frontend application at http://localhost:3000/ and the backend at http://localhost:3001/.