README.md

inno-alumni-portal

Website providing services for Innopolis University Alumni

Project Description

This website involves the ability to keep up with events happening in the univeristy, register for elective courses attendance and request a pass to enter university for different purposes.

Demo

(Screenshots and Video) https://youtu.be/PwiZH98iqJ8

Follow the link to watch the video

How to Use

1. Customer Complaints: Customers can submit complaints directly through the telegram group mentioed on the website.
2. Users Data Management: Admins are able to accept or deny requests from users with feedback (on reasons for example)
3. Pass Order: Alumni users can request a pass to enter the university for different purposes from the main page of the website
4. Elective Courses Participation Requests: Alumni users can request to attend elective courses held in the university at the time they are applying.

Frameworks and Technology

• Python FastAPI
• Next.js
• Docker
• PostgreSQL

How to Run:

• Instructions can be found in readme file in the frontend/backend folders

Alumni Portal Backend

How to run

Using Python

1. Open a shell/command line in this folder (better if it was after activating a python virtual env)
2. Install the needed python packages

    pip install -r requirements.txt

3. Run the python script:

    python3 main.py

Using docker

1. Here the image tag name is alumni-backend you can name it as you like
2. Also the port in docker is 8000 by default and locally you can map it to anything as you like

docker build -t alumni-backend
docker run -p 8000:8000 -d alumni-backend

Inno-alumni-portal frontend

How to run on local

1. Open a shell/command line in this folder
2. To install all packages (local to the repo) using npm

   npm install

3. To build the project for production

   npm run build

4. To start the project on development

   npm start