Nigiri Falls Takeaway

Handle takeaway orders with ease - Nigiri Falls Takeaway is a feature complete online takeaway ordering system for both employees and customers.

This project has been configured with Continous Integration and Continous Deployment from the start, and is available here.

Motivation

This project was started to create a complete takeaway ordering system for the sushi restaurant Nigiri Falls. It is meant to be user friendly, international and universally adaptable.

Build status

Code style

This project follows the PEP8 style guide for Python code, except E501. No specific style is used for HTML and CSS, but common sense applies. 😉

Screenshots

Tech/framework used

Built with

• Django
• Whitenoise
• AWS S3
• Bootstrap
• Weasyprint
• Django-Watson
• Heroku

Installation

1. Fork the repository.
2. Clone into it with git clone.
3. Go to /nigirifalls in your terminal of choice and run pip3 install -r requirements.txt to install dependencies.
4. Create a AWS S3 bucket and set your credentials as environment variables in your OS. Set AWS_STORAGE_BUCKET_NAME in settings.py to the name of your bucket.
5. Run python3 manage.py makemigrations and python3 manage.py migrate to create the database.
6. Run python3 manage.py runserver. A local instance of the website should be running at localhost:8000.

Tests

Run the unit tests by running python3 manage.py test. If you want a test report, ensure that you have Coverage installed, and run: coverage run --source='.' manage.py test coverage report

How to use?

See our wiki on GitLab! It contains a user guide, code overview, "How to contribute", product road map and documentation (In Norwegian).

License

No license is provided.