This is a simple but useful web application made with the intention to help my fellow students and me to manage our shared washing machine which we will be using in our dormitory.
This application is written in Python 3.11 and uses PostgreSQL as a database.
The full list of dependencies can be found in the requirements.txt file.
The app integrates a Celery worker and beat scheduler to handle asynchronous
tasks, for which you would need to install Redis and start at least one worker
and one scheduler.
- Install and set up your Python environment, PostgreSQL DBMS and Redis server.
- Clone this repository.
- Create a virtual environment by running
python -m venv venvand activate it. - Run
pip install -r requirements.txtto install all the dependencies. - Fill a copy of the .env.example files with your own values and rename it to .env.
- Migrate the database by running
flask db migrateand then upgrade it by runningflask db upgrade. - You are ready to go! Run
python main.pyto start the application.
Open http://localhost:5000 in your favorite browser and enjoy!
There are many ways to deploy a Flask app. The simplest one is to install gunicorn via pip install gunicorn
and run the WSGI server with the following command gunicorn --workers 4 --bind 0.0.0.0:5000 main:app.
Adjust the number of workers and the port to your needs.
This app comes with a set of tests which use pytest as a test runner. To run the tests install pytest and
run pytest ./tests in the root directory of the project.
This project is licensed under the GNU GPLv3 License - see the LICENSE file for details.