Backend

command module

v0.0.0-...-6cc2e2a Latest Latest Go to latest Published: Aug 4, 2023 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/SENG-499-Company2-B01/Backend

Links

Open Source Insights

README ¶

Company 2 | Scheduling Application Backend

Jakobs Scheduler

Project Description

This is a design project to create a course scheduler for the University of Victoria. One of the common problems the university administrators have is the logistic setup of physical resources for courses every academic year. There is a finite number of classrooms, time frames, and specialized equipment that must be assigned. The goal was to build an application based on previous years data that would help automate this process.

One of the main objectives for this project is not only devloping the application but to adhere to the SCRUM process and learn about how to work as part of a larger team. Our backend team has decided to devlop our part using Go as the main language and Python to handle some scripts. We containerize our listening server and Mongo database in docker containers to allow for modularity and future scalability.

Installation

Before we start, if you do not have Go or Docker on you local computer, you must follow the steps below and install them in order to run this project.

To install Go, please follow these steps:

Go to the official Go website by clicking on this link: https://go.dev/doc/install.
On the website, locate and click on the blue "Download" button. This will take you to a page where you can select the appropriate download for your Operating System.
Choose the download that matches your Operating System and click on it to start the download.
Once the download is complete, run the installer and follow the usual steps to install Go.
During the installation process, ensure that Go is added to your environmental path. If it doesn't do so automatically, you may need to set it up manually.
To verify that Go was installed correctly, open your CMD (command line interface) of choice and enter the command go --version. This command should display the installed version of Go if the installation was successful.

To install Docker, please follow these steps:

Visit the official Docker website by going to https://www.docker.com/get-started.
On the Docker website, you should see a "Get Started with Docker" section. Choose the option that corresponds to your Operating System (e.g., Docker Desktop for Windows, Docker Desktop for Mac).
Click on the download link provided for your chosen Operating System.
Once the download is complete, run the installer that was downloaded.
Follow the on-screen instructions to install Docker on your machine. The installation process may require administrative privileges, so make sure to grant the necessary permissions.
During the installation, you may be prompted to configure additional settings or select optional components. Make any desired selections or keep the default options, and proceed with the installation.
After the installation is complete, Docker should be available on your computer.
To verify that Docker is installed correctly, open a command line interface (e.g., Command Prompt on Windows, Terminal on macOS) and enter the command docker --version. This command should display the installed version of Docker if the installation was successful.
Optionally, if you are on windows, you may need to install WSL (Windows Subsystem for Linux). To do this:
- Open PowerShell as an administrator. You can do this by right-clicking on the Start menu, selecting "Windows PowerShell (Admin)."
- In the PowerShell window, run the following command to enable the Windows Subsystem for Linux feature:
  
  wsl --install
  
  This command will automatically enable the necessary components and install a WSL-compatible Linux distribution from the Microsoft Store.
- Wait for the installation process to complete. It may take a few minutes as it downloads and sets up the Linux distribution.
- Once the installation is finished, you will be prompted to create a new user account and set a password for the Linux distribution. Follow the on-screen instructions to complete this step.
- After creating the user account, WSL is ready to use.

By following these steps, you will successfully install Go and Docker on your machine.

Now we can move onto installing the project on your machine in order to configure and run it.

To start, clone the repository onto your machine. If you are unsure on how to do this:

Continue to the root page of this repository.
Click on the blue '<> Code' button near the top and copy the HTTPS link.
Open your chosen command line interface and type the command

git clone https://github.com/SENG-499-Company2-B01/Backend.git

After is completes, you should be able to open the project in your prefered development environment.

Configuration

Configuration for this project is very simple!

Open the project in your developement environment and create a new file in the root folder called .env. In there you must follow this exact format, but feel free to change the values as you see fit. Also note that if you are running this project after Augest of 2023, the cloud will no longer be running, so you must change the environment to 'development' unless you set up your own cloud deployment (including running the algorithm APIs)

# Set this variable to 'production' or 'development'
ENVIRONMENT=production

# Development (local)
MONGO_LOCAL_HOST=10.9.0.3:27017
MONGO_LOCAL_USERNAME=admin
MONGO_LOCAL_PASSWORD=admin

# Production (cloud)
MONGO_PRODUCTION_HOST=company2-mongocluster.p0vfwcg.mongodb.net
MONGO_PRODUCTION_USERNAME=admin
MONGO_PRODUCTION_PASSWORD=LcKERy6JYJGNdfOZ

#Algs 1 & 2 APIs
ALGS1_API=https://c2algs1.onrender.com/generate
ALGS2_API=https://algs2.onrender.com/predict

# Shared
ADMIN_1=rich.little
ADMIN_2=dan.mai
JWT_SECRET=secret
API_HASH=fe80decbd03b2933f3d7eba3079e6b3e7c1bb2e3613f3671388c969fd6cd5aca

Usage

The usage of our project is also very simply!

Firstly, you need to start docker for the containers the project will run in, use the following steps:

Open Docker Desktop on your computer. This application manages the Docker environment and allows you to control containers.
- If you are using Windows or macOS, you can find the Docker Desktop icon in the system tray or the applications menu. Click on it to open Docker Desktop.
- If you are using Linux, open a terminal and run the command to start the docker service on your machine.
```
sudo service docker start
```
To verify that docker is running, you can use the following command in your CLI. If it returns an error, docker is either not running or was not set up correctly.
```
docker info
```
After confirming that Docker is running, navigate to the directory where your project's docker-compose.yml file is located. This file defines the containers and their configurations.
To start the containers defined in your docker-compose.yml file, run the following command:
```
docker-compose up
```
Optionally, you can add the -d flag at the end of the command to detach the containers from the CLI. This allows them to run in the background while you continue to use the CLI for other tasks.
```
docker-compose up -d
```
This command will spin up the containers and their dependencies, as specified in the docker-compose.yml file.

You are now ready to interact with the server. This backend part of the project is strictly an interface to the outside to allow for the other aspects of the project to communicate.

To interact with one of the server endpoints, you must send a request like any other API. Our services include:

Signin
Users
Classrooms
Courses
Schedules

API Examples

Some examples of the requests are as follows:

Endpoint: http://localhost:8000/login

Method: POST

Body: POST

username (string): The username of the user.
password (string): The password of the user.

Returns:

JWT token (string): A JSON Web Token (JWT) representing the user session.

Description:

Establishes a user session with the server by sending the user's login credentials (username and password) in the request body. If the provided credentials are valid, the server will respond with a JWT token, which can be used to authenticate subsequent requests to protected endpoints on the server.

Example Request:

POST /login HTTP/1.1
Host: localhost:8000
Content-Type: application/json
Accept: application/json

{
  "username": "Example.User",
  "password": "Example.User12345"
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImV4YW1wbGVfdXNlciIsImlhdCI6MTYzMTg4MzM2OSwiZXhwIjoxNjMxODg2OTY5LCJzdWIiOiIxMjM0NTY3ODkwIiwianRpIjoiMTIzNDU2Nzg5MCJ9.FHJhGKQ6b4liP2E-8xw-HUNdbm9AhNDeJ3pHeKf4scw"
}

Endpoint: Generating a schedule

Endpoint: http://localhost:8000/:year/:term/generate

Method: POST

Body: POST

Token (string): A JSON Web Token (JWT) representing the user's authentication.
Admin (boolean): A flag indicating whether the user has administrative privileges.
Schedule: The schedule data or configuration needed for term generation.

Returns:

Schedule: The generated schedule for the specified year and term.

Description:

This endpoint supports the generation of schedules for the given academic year and term. The user needs to provide a valid authentication token (JWT) to access this endpoint. Additionally, administrative privileges are required to use this endpoint successfully. The schedule data or configuration required for term generation should be included in the request body.

Example Request:

POST /schedules/2023/fall/generate HTTP/1.1
Host: example-api.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMTIzNDU2Nzg5MCIsImFkbWluIjp0cnVlLCJpYXQiOjE2MzE4ODMzNjksImV4cCI6MTYzMTg4Njk2OSwiYXVkIjoiZXhhbXBsZS1hcGkiLCJpc3MiOiJleGFtcGxlLWFwaSIsInN1YiI6ImV4YW1wbGVfdXNlciJ9.FHJhGKQ6b4liP2E-8xw-HUNdbm9AhNDeJ3pHeKf4scw
Content-Type: application/json

{
  “courses”: [
    {
      “course”: “ECE471”,
      “peng”: true,
      “prerequisites”: [[“ECE310”],[“CSC115”, “CSC116”],...],
      “corequisites”: [,],
      “pre_enroll”: 65,
      “min_enroll”: 5,
      “hours”: [3, 1.5, 0],
    },
    ...
  ],
  “classrooms”: [
    {
      “building”: “ECS”,
      “room”: “123”,
      “capacity”: 150,
    },
    ...
  ],
  “professors”: [
    {
      “name”: “Rich Little”,
      “peng”: true,
      “max_courses”: 5,
      “course_pref”: [“CSC110”, “CSC230”,...],
      “time_pref”: {
        “M”: [[“08:30”, “16:00”],],
        “T”: [[“08:30”, “16:00”],],
        “W”: [[“08:30”, “16:00”],],
        “R”: [[“08:30”, “16:00”],],
        “F”: [[“08:30”, “10:30”], [“12:00”, “16:00”]],
      }
    },
    ...
  ]
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  “schedule”:[
    {
      “course”: “CSC110”,
      “sections”: [
        {
          "num": “A01”,
	    “building”: “ECS”,
          “room”: “125”,
     	    “professor”: “Rich Little”,
	    “days”: [“M”, ”R”],
	    “start_time”: “08:30”, // 24hr time
	    “end_time”: “09:50”,
          “num_seats”: 60,
	  },
	  {
	    "num": “A02”,
	    “building”: “ECS”,
  	    “room”: “123”,
	    “professor”: “Nishant Mehta”,
	    “days”: [“M”, “R”],
	    “start_time”: “10:00”,
	    “end_time”: “11:20”,
          “num_seats”: 60,
	  },
	],
    },
    ...
  ]
}

For more endpoint examples, please contact someone from our backend team, or refer to the Company SRS document.

Contributing

As this is currently a private project without external help, feel free to reach out to our backend team if you want any changes or help and we will get back to you as soon as possible.

For developers:

For bug reports clearly outline what the bug is, how to reproduce it and provide screenshots or a video.
For feature requests, clearly outline what the requirements for the feature are and why you think this feature is needed.
For pull requests, clearly outline what feature this is for (ticket number), what changes were made, and how to test is with optionally screenshots or a video.