Gymkhana
A web application for managing various gymkhana activities like club
registration, event management, inventory management, booking club
merchandise, etc. for all the gymkhana clubs in our institute.
Tech stack
Prerequisites for Setup
Create an OAuth2 Client
- Go to the Google Cloud Platform Console
- From the projects list, select a project or create a new one
- If the APIs & services page isn't already open, open the console left side menu and select APIs & services
- On the left, click Credentials
- Click New Credentials, then select OAuth client ID
- Select
Web application
in the Application type
- Give a name to the application
- In Authorized Javascript origins add
http://localhost:3000
- In Authorized redirect URIs add
http://localhost:3000/login/redirect
- Click on Create button
- Note Client ID and Client Secret
Local Setup
- Fork and clone the repository.
- Add remote upstream
git remote add upstream https://github.com/BitByte-TPC/gymkhana.git
- ui setup
- api setup
Setup using docker
- Fork and clone the repository.
- Add remote upstream
git remote add upstream https://github.com/BitByte-TPC/gymkhana.git
- Create a new file in both
api
& ui
directories named: .env
and
copy all the content from the respective .env.template
files.
- Run
docker compose up
to start
Design Docs
Want to contribute?
Check out CONTRIBUTING.md.