Skip to content

This platform is crafted to optimize the authorization process for events and purchases within the student gymkhana office. It enables a systematic workflow for automating approvals, generating requests, and managing data.

Notifications You must be signed in to change notification settings

rudra-iitm/club_catalyst

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

98 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Club-Catalyst

Links

Overview

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.

Approval Automation

  • 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.

Request Generation

  • 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.

Run Locally

To get started with the project locally, follow the steps below:

Clone the project

  git clone https://github.com/Rudra-IITM/club_catalyst

Using Docker

If you prefer using Docker for managing the project environment, follow these instructions:

  1. Navigate to the project directory:
    cd club_catalyst
  1. Ensure that Docker is installed on your system and the Docker daemon is running.

  2. Run the following command to start the project using Docker:

  docker-compose up -d # To run in detached terminal

Manual Setup

Go to the project directory

  cd club_catalyst

Set up backend

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

Set up frontend

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

Accessing the Application

Once the project is running, you can access the frontend application at http://localhost:3000/ and the backend at http://localhost:3001/.

About

This platform is crafted to optimize the authorization process for events and purchases within the student gymkhana office. It enables a systematic workflow for automating approvals, generating requests, and managing data.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages