Student Welfare Backend

API for the student welfare website and app

---

Table of Contents

• Key Features
  • Users
  • Clubs
  • Events
  • Notifications
• Usage
  • Spin up all the containers
  • Migrate changes to the database
  • Create a superuser
  • Other management commands
  • Stop all the containers
  • View logs
  • View logs for a specific container
  • Run any command inside a container
• API Documentation
• Developer

Key Features

Users

• Custom User Model for Admin, Faculty and Student
• JWT based user authentication
• Email OTP Verification
• User Bulk Upload

Clubs

• CRUD operations for clubs
• Bulk Upload for clubs from CSV

Events

• CRUD operations for events
• Bulk Upload for events from CSV

Notifications

• Push notifications

Usage

Here are some commonly used commands -

Spin up all the containers

./sw.sh up -d --build

Migrate changes to the database

./sw.sh run --rm django python manage.py migrate

Create a superuser

./sw.sh run --rm django python manage.py createsuperuser

Other management commands

./sw.sh run --rm django python manage.py <command>

Stop all the containers

./sw.sh down

View logs

./sw.sh logs -f

View logs for a specific container

./sw.sh logs -f <container_name>

Run any command inside a container

./sw.sh run --rm <container_name> <command>

For windows, use sw.cmd instead of sw.sh

For local development, use ./sw.sh local instead of ./sw.sh

NOTE : The container name can be found in the docker-compose.yml file

NOTE : The sw.sh script is a wrapper around the docker-compose command. You can use docker-compose instead of ./sw.sh if you want to.

API Documentation

Postman API Documentations - Student Welfare Backend

Developer

Dhruv Shah

Made with ❤ by GDSC-VIT