37 lines
1.3 KiB
Markdown
37 lines
1.3 KiB
Markdown
markdown
|
|
# Daily Habit Counter App
|
|
|
|
This is a simple habit tracking web app that allows the user to track occurrences of events in a day.
|
|
|
|
## Screenshots
|
|
|
|
| | |
|
|
|:----------------------:|:------------------------:|
|
|
|  |  |
|
|
| Main Page | Statistics page |
|
|
|
|
## Features
|
|
|
|
* Create any numbers of counters for tracking events
|
|
* Color encode every counter
|
|
* View statistics about how often each event occurs
|
|
|
|
## Run project (Locally with Python )
|
|
|
|
**Pre-requisites:** [Pip](https://pypi.org/project/pip/) and [Poetry](https://pypi.org/project/poetry/)
|
|
|
|
1. Clone this repository
|
|
2. Create a virtual environment with ``python3 -m venv ./.venv``
|
|
3. Activate virtual environment with ``source .venv/bin/activate``
|
|
4. Install project dependencies ``poetry install``
|
|
5. Run database migrations ``alembic upgrade head``
|
|
6. Run project ``streamlit run app``
|
|
7. Project will be running at http://localhost:8501
|
|
|
|
## Run project (Locally with Docker)
|
|
|
|
**Pre-requisites:** [Docker](https://www.docker.com)
|
|
|
|
1. Clone this repository
|
|
2. Build Docker Image ``docker build -t habit-counter:latest .``
|
|
3. Run Docker container ``docker run habit-counter`` or to preserve the data ``docker run -v ./data:/app/data habit-counter`` |