This repository contains the entire Django configuration and secret keys(!), as well as the game itself (the django app "zylinder_app"). While this is bad practice, this is for debugging and development only.

luxti 187ade7dd3 added forgotten changes 3 years ago
misc b7b7432007 initial infra work 3 years ago
zylinder 187ade7dd3 added forgotten changes 3 years ago
.gitignore 0c0e9663eb moved things around 3 years ago
README.md 187ade7dd3 added forgotten changes 3 years ago
requirements.txt 187ade7dd3 added forgotten changes 3 years ago

README.md

#zylinder is the project and contains settings for django. zylinder_app is the main game. index is only responsible for the login/logout at the moment. This would be better in an own app, but for our case it's easier this way.

This allows for zylinder being pluggable into other django projects, since it doesn't bring its own login system, which means it can use existing accounts.

NOTE: the only interesting part should be the zylinder_app, the rest should only be considered as a placeholder for a real website. For this reason, this repository also contains the Django secret key.

Authors: Samir Nasher Taher Tim Lux

Licence: AGPL

Install from scratch:

  1. Create a python venv with python -m venv zylinder_venv
  2. Enter it and activate it (in GNU: bin/activate)
  3. clone the repository in the venv
  4. install dependencies with pip install -r zylinder/requirements.txt
  5. go into zylinder/zylinder
  6. ./manage.py migrate
  7. enter your finnhub token at zylinder_app/backend/finn_token.py
  8. Wait for the updating to stop. This will take around ten minutes - enjoy a coffee in the mean time.
  9. start the server with ./manage.py runserver
  10. enjoy the game at http://localhost:8000