Important
Not all features described are implemented. Please have a look at the roadmap section.
Health Patterns is designed to allow users to easily track pain events. Details can be provided for further analysis and to discover the user's own patterns. Data can be exported as a PDF for offline storage or to show to healthcare professionals. The user system is completely anonymous and it's possible to encrypt one's data.
We are currently rebuilding Health Patterns to run natively and offline on mobile devices with local storage and sync with the backend. The goal is to eventually be able to ship an app for IOS/Android.
| Feature | Frontend | Backend |
|---|---|---|
| Pain tracking | ✅ Implemented | ✅ Implemented |
| Analysis | ❌ Not implemented | ❌ Not implemented |
| PDF export | ❌ Not implemented | ❌ Not implemented |
| Encryption | ❌ Not implemented | ❌ Not implemented |
| User System | ✅ Implemented | ✅ Implemented |
| Native App | 🔨 Under construction | ❌ Not relevant |
| Sync Function | ❌ Not implemented | ❌ Not implemented |
Make sure you have the latest versions of docker and docker compose installed on your system. Alternatively install the latest version of Docker Desktop.
- Clone the repository
git clone https://github.com/wmneco/HealthPatterns.git
- Go into the folder
cd HealthPatterns
-
Unzip the project-ZIP with a tool like 7zip
-
Open the unzipped folder in the terminal
-
Make sure you are in the correct directory
pwd #should return 'HealthPatterns'
Launch health patterns with:
docker compose upOnce all the Docker containers are running, open your browser and check out your localhost.
- you will be asked to accept the unsafe connection because we are using a self-signed certificate for local development
https://localhostIf you would like to view our api-documentation or test endpoints that have no frontend yet, please use this link:
https://localhost/api/docsStop Health Patterns with:
docker compose downThe database is persistent between container up/down. To reset the database do the following:
- this is an issue if you still have an old version's database on your system
- if there are database errors this is a good first troubleshooting step
-
Stop the app:
docker compose down
-
Remove the database container:
docker rm aid-db
-
Remove the database volume:
docker volume rm aid-vault_postgresql
-
Restart the app:
docker compose up
Since all dependencies are installed in the containers there will be error-messages and no code suggestions in the local IDE. To remove the errors and get suggestions install the requirements on your local machine.
-
Backend requirements:
- Python 3.11.5
- dependencies (it is recommended to install those in a virtual environment):
pip install -r backend/requirements_local.txt
-
Frontend requirements:
- Please install the Svelte for VS Code extension.
- Optional: Install Node
- dependencies installation:
cd frontend/aid-vault npm install