sglavoie / uol-grades-calculator-server

Provides a server to work with ugc visually (https://github.com/sglavoie/uol-grades-calculator/)

Server for ugc (UoL Grades Calculator)

This repository will serve to interface with the ugc CLI tool by providing an API with FastAPI as well as a front-end built with React. More to come!

Setting up the back-end

Install dependencies:

pip install -r backend/requirements.txt

Run the server:

cd backend
python src/main.py

Testing changes made to ugc before publishing to PyPI

Via GitHub

In backend/requirements.txt, comment out the line uol-grades-calculator and add a new line as follows:

git+https://github.com/sglavoie/uol-grades-calculator@BRANCH_NAME#egg=uol-grades-calculator

The GitHub repository for ugc will be cloned when installing the dependencies and the source code will be coming from the branch BRANCH_NAME. The bit at the end, #egg=uol-grades-calculator, will tell pip to install the package with the same name as before: uol-grades-calculator.

Via local installation

Assuming requirements are already installed, it is possible to uninstall uol-grades-calculator and reinstall it from a local repository to avoid pushing changes to the remote altogether. To do so:

pip uninstall uol-grades-calculator
pip install /home/user/path/to/uol_grades_calculator

# Then, just re-launch the server
python src/main.py

Setting up the front-end

Install dependencies:

cd frontend
yarn  # or npm install

Run the server:

cd frontend
yarn start