Elternbrief is a web application built using Django. This repository contains a complete Django project ready to be tested on any system that supports running Python applications.

Table of Contents

• What is Elternbrief?
• What is the current state of the project?
• Requirements
• Getting started
• Licensing
• Contributing

What is Elternbrief?

Originally started as a school project, Elternbrief aims to allow schools to digitally distribute letters to parents of students. Parents are able to confirm these letters inside the application as well, reducing the waste of paper and also allowing said letters to be managed in a central way, relieving teachers from having to chase after forgetful students.

What is the current state of the project?

Elternbrief is still in a very early stage. Most key features are implemented in a basic way but are far from being complete. Currently the interface presents an adventurous mix of text in German and English language, and there are quite probably more than a few bugs hidden throughout the code. Fixing the interface and getting the most essential features done will be my task during the coming months. Also, we will start with extensive testing with real users at some point soon in order to uncover other problems.

Requirements

• Python 3.6 or higher

• Some WSGI-capable web server (e.g. NGINX or Apache), or use Django’s included webserver for testing

• Python packages:

  • django 3.0.7 or higher

  • django-tables2 2.3.1 or higher

• Yarn for installing necessary node modules

ℹ️	The versions of the packages listed here are just a reference of which versions I have tested and that definetely work. The project might also work with older versions of these packages perfectly fine. However, I always recommend using the latest version of every component as a best-practice.

💡	You can automatically install all required python packages by running pip install -r requirements.txt

Getting started

The Elternbrief Wiki holds information about how to get Elternbrief running in different scenarios and will continue to be updated as the project progresses.

Licensing

Elternbrief is available under the MIT license. This project also includes code that belongs to the Django project, which is not owned by me and is distributed under its own license. For more information, see the LICENSE-file.

Contributing

I am still in the process of cleaning up and documenting the code. However, if you are interested in the project and want to contribute, if you want to use it yourself and need help getting started, or if you have any other question, do not hesitate to contact me. :)