Open source backend for TIHLDE's website.
Lepton requires Docker and Docker Compose.
# Setup a local repository
git clone https://github.com/tihlde/Lepton.git
cd Lepton
# If this is your first time running the application
make fresh
# Thats it!
From now on it's enough to run make start to run the application.
We use GNU Make to simplify common commands.
Have a look at the makefile to find out more about how to run the project without it.
No configuration is required to get started, but if you would like to configure further or override existing ones, put the following environment variables in a .env file in the repository root.
# Database connection variables
DATABASE_HOST= HOST_URL
DATABASE_NAME= DATABASE_NAME
DATABASE_PASSWORD= PASSWORD
DATABASE_PORT= PORT (normally 3306)
DATABASE_USER= USERNAME
# Optional for using mailing
EMAIL_HOST= HOST_URL
EMAIL_PORT= PORT (normally 587)
EMAIL_USER= EMAIL_USER
EMAIL_PASSWORD= EMAIL_PASSWORD
# Optional for uploading files to Azure
AZURE_STORAGE_CONNECTION_STRING= CONNECTION_STRING
The tests can be run with pytest by running make test.
To run with test coverage, run make test args="--cov".
The Lepton backend is an open source project built on voluntary work. We are committed to a fully transparent development process, and highly appreciate any contributions. Whether you are helping us by fixing bugs, proposing new feature, improving our documentation, or simply spreading the word - we would love to have you as part of our community.
Feel free to file a new issue with a respective title and description
in the TIHLDE/Lepton repository.
If you have already found a solution to your problem, we would love to review your pull request!
We enforce the PEP-8 style guide with isort, black and flake8.
Have a look at setup.cfg to find out more about our coding standards.
Feel free to send us a message on our official slack channel, or email us at [email protected].
The code in this repository is licensed under the MIT license.