Initial import
This commit is contained in:
36
README.md
Normal file
36
README.md
Normal file
@@ -0,0 +1,36 @@
|
||||
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. Install Poetry ``pip install -Iv --no-cache-dir "poetry==2.3.3"``
|
||||
3. Install project dependencies ``poetry install``
|
||||
4. Run database migrations ``alembic upgrade head``
|
||||
5. Run project ``streamlit run app``
|
||||
6. 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``
|
||||
Reference in New Issue
Block a user