vplan-fr / VPlan_FR

GNU General Public License v3.0
5 stars 0 forks source link

Better VPlan Logo

vplan.fr

This repository contains the code of the website vplan.fr, which is free to use and already supports many schools in (eastern) Germany! If you want to contribute to the project, contact us, submit an issue or fork this repo and create a pull request for changes.

Preview Image of example school

Installation

To get started, install Python >= 3.11 and the requirements:

Next, install Node.js and the used packages:

MongoDB is also a requirement and needs the following collections:

Getting started

The plan crawler can be started with the following command:

To run the plan loader once instead of continuously, the flag --once can be set in the command above.

A .env file has to be created in the project root, containing the following variables:

To start the website, start the flask server using:

and in another terminal, the npm dev server using:

If you have any more questions or need help with the setup, don't hesitate to contact us. :)