bemxio / jedyneczki

A website in Polish, showing how much F's I have got in school

jedyneczki

A website showing how much bad grades I got, from the beginning of the year to now!

Made in Python, using FastAPI and vulkan-api.

Running

Make sure you're running Python 3.7+ before doing any steps.

1. Clone the repository into a directory of your choice.
2. Move to the directory with the files in a terminal.
3. Log into the Vulcan e-register student/parent panel, and move to the "Mobile access/Dostęp mobilny" tab.
4. Click the "Generate access code/Wygeneruj kod dostępu" button to generate the values needed for logging in.
5. Run python3 tools/create_account.py and fill all of the values provided from the Vulcan website.
6. Create a new file called uvicorn.json & fill it according to the template below.
   • See the Uvicorn page for more details about available options.

{
    "host": "<YOUR_DESIRED_HOSTNAME_HERE>",
    "port": <YOUR_DESIRED_PORT_HERE>
}

6. Run python3 -m pip install -r requirements.txt to install required requirements.
7. Done! To run the website, do python3 main.py.

Contributing

As with all my projects, contributions are highly appreciated!