Room Signage

Master branch:

Develop branch:

Installation

In order to make this project run make sure that you have the follow pre-requirements installed

• Python 3.7
• Pip
• Docker (or docker desktop for windows)
• docker-compose (already installed with docker desktop)

Now follow those steps to get everything working

1. Install requirements pip3 install -r requirements.txt
2. Start the database cp .env.example .env
3. Start the database docker-compose up -d db
4. Setup the database python3 manage.py migrate
5. Add data to database python3 manage.py seed
6. Run the server python3 manage.py runserver (or docker-compose up web)

Testing

1. Run tests pytest
2. Run linter flake8 .
3. Run JS linter eslint mysign_app
4. Run HTML linter jinjalint

If you get import order errors run isort. If you get JS linter errors run eslint mysign_app --fix

License

This software is freely distributable under the terms of the MIT license.