University Credit and Time Table Management System

Table of Contents

1. About The Project
   • Built With
2. Deployment
3. Getting Started
   • Prerequisites
   • Installation
4. Usage
   • Local Run
   • Docker Run
5. Design Document
6. Contributing
7. License
8. Contact

About The Project

This project will create a web application that will allow administrators to configure slots, add faculties, and allocate courses at specific slots. Students will be able to register for courses by specifying the course ID, slot ID(s), and faculty ID. The application will ensure that only one course can be selected at a specific time slot, and that the selected faculty must be teaching the course at that slot. The application will be built using a relational database (PostgreSQL or MySQL) and will adhere to the OpenAPI schema.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

• Install Node.js and npm
• Install PostgreSQL

Setup

• Clone the repo

  git clone https://github.com/guptaharsh13/FFCS

• Change into the directory

  cd FFCS

• Environment Variables

  touch .env

  For running this project successfully you'll need to create a .env file and store your PostgreSQL there like .env.sample.

(back to top)

Usage

Local Run

Install NPM packages

npm i

Start the app

npm start

Get the STUDENT_AUTH_TOKEN and ADMIN_AUTH_TOKEN

npm run auth

Docker Run

docker-compose up --build -d

Get the STUDENT_AUTH_TOKEN and ADMIN_AUTH_TOKEN

docker exec -it api sh
npm run auth

Now, may access the app on http://localhost:PORT

PORT: You must have already specified in the .env file (3000 by default)

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Harsh Gupta - hg242322@gmail.com

GitHub Link: https://github.com/guptaharsh13

(back to top)

Made with ❤ by Harsh Gupta