mariano/orario-scolastico-itet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Orario Scolastico is a web app that displays school timetables in a more readable format by downloading the PDF from the school website. https://orario.riefolo.me
46 Commits 3 Branches 0 Tags 995 KiB
Rust 45.8%
JavaScript 33.9%
HTML 15.2%
Dockerfile 2.6%
Python 2.5%
81b859aca9
Go to file
Mariano Riefolo 81b859aca9 refactor(api): change 'docente' variable name to 'teacher' in get_header function
2024-10-03 19:14:37 +02:00
src refactor(api): change 'docente' variable name to 'teacher' in get_header function 2024-10-03 19:14:37 +02:00
static feat: add manifest and icons 2024-09-15 16:41:48 +02:00
templates feat: add manifest and icons 2024-09-15 16:41:48 +02:00
.gitignore feat(api): implement 30-minute cache for PDF link requests 2024-09-04 16:25:27 +02:00
Cargo.lock chore: bump version to 0.2.0 2024-09-07 14:38:34 +02:00
Cargo.toml chore: bump version to 0.2.0 2024-09-07 14:38:34 +02:00
docker-compose.yaml feat(docker): add docker and compose support 2024-09-04 13:02:49 +02:00
Dockerfile feat(docker): add docker and compose support 2024-09-04 13:02:49 +02:00
LICENSE docs: add README and LICENSE files 2024-09-05 17:48:27 +02:00
pdf2csv.py feat(api): add PDF download and CSV conversion functionality 2024-09-02 11:53:24 +02:00
README.md docs: add README and LICENSE files 2024-09-05 17:48:27 +02:00

README.md

Orario Scolastico

Orario Scolastico is a web application that allows students to view their school timetable in a more readable way. The application works by downloading the PDF file containing the timetable from the school website and then displaying it in a more user-friendly format.

Requirements

If you want to use Docker Compose

If you don't want to use Docker Compose

Usage

If you want to self-host the project, you can follow the steps below:

With Docker Compose

git clone https://git.riefolo.me/mariano/orario-scolastico-itet.git
cd orario-scolastico-itet
docker compose up -d --build

Without Docker Compose

If you prefer to build the project without Docker, you can follow the steps below:

git clone https://git.riefolo.me/mariano/orario-scolastico-itet.git
cd orario-scolastico-itet
cargo build --release
./target/release/orario-scolastico-itet

Consider that this may not work if you are not on a Linux machine.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

FAQ

Does this project DoS the school website?

The project features a cache system that prevents it from making too much requests. The list of PDFs is only fetched every 30 minutes only if a user asks for it, and the pdf files are only fetched once per file.

Can I use this project with my school?

At the moment, the project is only compatible with the ITET Cassandro Fermi Nervi institute in Italy.

License

Orario Scolastico is released under the Mozilla Public License 2.0