diff --git a/README.md b/README.md index cf9fca155d4a8cc07acf919f53b806e9356b4d0c..f8ec4c0c5b02acac0bd20c232eea0256fd60f3e5 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,29 @@ # Wahlfang +> A self-hostable online voting tool developed to include all the +> features you would need to hold any online election you can dream of -StuStaNet Online Wahl-Tool +Developed by [StuStaNet](https://stustanet.de) Wahlfang is a small-ish Django project +which aims at being an easy to use solution for online elections. From simple one-time +votes about where to grab a coffee to large and long meetings with multiple different +votes and elections - Wahlfang does it all. -## Setup +If you would like a new feature or have a bug to report please open an issue over +at our [Gitlab](https://gitlab.stusta.de/stustanet/wahlfang/-/issues). + +## Getting Started ```bash $ cd wahlfang $ pip3 install -r requirements.txt $ python3 manage.py migrate +$ python manage.py runserver ``` ### Management Access Creating a local election management user: ```bash -$ python3 manage.py +$ python3 manage.py crreate_admin ``` The admin interface is accessible at [http://127.0.0.1:8000/admin/](http://127.0.0.1:8000/admin/). @@ -39,13 +48,13 @@ $ python3 manage.py create_voter --election_id 1 --voter_id 1337 You can then login with the printed access code. -## Run Development Server +## Contributing Starting the server: ```bash $ python3 manage.py runserver ``` -If some model changed, you might have make and/or apply migrations again: +If some model changed, you might have to make and/or apply migrations again: ```bash $ python3 manage.py makemigrations $ python3 manage.py migrate