 |
 |
 |
 |
 |
|---|
Mindease is an open-source web application built with Flask. It allows users to track and work to elevate their mood swings on a daily basis using a scale. Additionally, users can journal to reflect on their day, share their progress with a psychologist, and unwind while listening to instrumental music that encourages meditation.
This documentation is intended for hobbyists or businesses who want to host this web application on their own servers and link it to their own database.
python - >= v3.10
make - You might want to use Chocolatey in order to install make on Windows
pip - Usually comes with Python but you might need to manually install it
mysql - Must be up and running on port 3306 with a ready to use database
git bash (or similar) - For Windows users only
phpmyadmin (Optional) - In case you need a decent Web GUI to administer the database
Follow the steps below in order to properly host and run the application
Note: Windows users might need to use a bash terminal such as git bash in order for this to work correctly.
Clone the project
git clone https://github.com/bigcbull/mindease.gitGo to the project directory
cd mindeaseCreate and activate a virtual environment - (Linux/macOS)
python -m venv venv && source ./venv/bin/activateCreate and activate a virtual environment - (Windows)
python -m venv venv && source ./venv/Scripts/activateInstall required dependencies
make initCreate a .env file inside the project's root directory, and set the following parameters inside it:
DATABASE_NAME = <Your Database Name>
DATABASE_HOSTNAME = <Your Database Hostname>
DATABASE_USER = <Your Database User>
DATABASE_PASSWORD = <Your Database Password>
APP_PORT = <Desired App Port>
APP_SECRET_KEY = <Random Solid Key>
# Example:
DATABASE_NAME=mindease
DATABASE_HOSTNAME=db.mindease.com
DATABASE_USER=mindease_user
DATABASE_PASSWORD=XPxv39ebR5P4B4a
APP_PORT=5000
APP_SECRET_KEY=SyRe462xk9uScqBRun database configuration (which configures your database automatically):
make dbRun the application (production mode):
make runImportant: Always reactivate the virtual environment before running the application.
To execute tests and linters, run the following command
make test dir=./src/utils/<package>Example - To run tests and linters on the user package one can do the following:
make test dir=./src/utils/userNote: Windows users must use a bash terminal such as git bash in order for this to work correctly.
To view documentation for specific module, run the following command
make doc module=./src/utils/<package>/<module>.pyExample - To view documentation for the user module in the user package one can do the following:
make doc module=./src/utils/user/user.pyNote: Windows users might need to use a bash terminal such as git bash in order for this to work correctly.