This web app gives users the ability to track migraines and view basic trending statistics regarding their migraine attacks. This is a work in progress, you can see my plans for the app here. Eventually I plan on having this app hosted using AWS but this won't take place until the MVP (Minimal Viable Product) is complete. The MVP of this project will include the ability to create an account, log a migraine, and edit/view the details for each migraine entered.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Install Docker

On Mac:

brew install docker

Clone this repo.

git clone https://github.com/discocorg/migraineapp.git

If changes have been made to the database model run this command in the web container, for example: mgappdocker_web_1

python3 manage.py migrate

And to launch the web app:

docker-compose up

TODO: End with a small demo.

Explain how to run the automated tests for this system

Explain what these tests test and why

Give an example

Explain what these tests test and why

Give an example

TBD: Planning on using Docker and AWS tools to deploy.

This app is built with the Django Framework and Postgres as a database. It is built with the goal of using docker to ultimately deploy the app.

• Django - The web framework used
• Bootstrap 4 - The css framework used
• pgAdmin 4 - UI for Database Configuration
• Postgres - Database
• Docker - Used to make development/deployment easier.

For now this repo is a private project and I don't plan on others being interested in contributing. If you are interested or have questions please open an Issue on Github.

TODO: I plan on using SemVer for versioning. For the versions available, see the tags on this repository.

Just me so far.

See also the list of contributors who participated in this project.

This project is licensed under the MIT License - see the LICENSE.md file for details

TBD