"It will boost your immune system!"

An exciting web app that suggests restaurants to eat at in your local area that have a very poor food hygiene rating

DangerDine uses Python 3.11, please ensure you have this version installed (downloads available here)

For windows install using these 3 links (in order):

• http://www.gaia-gis.it/gaia-sins/windows-bin-x86
• https://trac.osgeo.org/osgeo4w/ (Select Express Web-GIS Install and click next. In the ‘Select Packages’ list, ensure that GDAL is selected. If any other packages are enabled by default, they are not required by GeoDjango and may be unchecked safely)
• https://docs.djangoproject.com/en/4.2/ref/contrib/gis/install/#modify-windows-environment

For linux install using this command:

sudo apt install libsqlite3-mod-spatialite && sudo apt install binutils libproj-dev gdal-bin

Ensure that you have Poetry installed (instructions can be found here), then navigate to the root folder and run the following command:

poetry install --no-root && poetry run pre-commit install

Poetry will complain if you do not have the correct Python version installed. Follow the steps in Installing to get the correct version

To run the program you may need to set some environment variables (E.g. SECRET_KEY), the required ones are specified in .example.env and must be placed into a file called .env in the project root.

Contributions are welcome. If you want to contribute, please raise a PR, and we'll review, test and (likely) merge it. Please comment on issues you'd like to work on for assignment to prevent duplication of work. If you find any bugs/problems or have any feature suggestion, please raise an issue.

Please ensure your new code adheres to mypy's type checking & ruff's linting so that the repo has a consistent style. By also running pytest's test suite you can ensure your contributions provide valid functionality.