{"id":29016376,"url":"https://github.com/github-main-user/quick-habit","last_synced_at":"2026-04-13T03:04:26.051Z","repository":{"id":301226579,"uuid":"1008571214","full_name":"github-main-user/quick-habit","owner":"github-main-user","description":"🧠 A minimalistic habit tracker backend inspired by Atomic Habits. Includes Telegram reminders, Docker setup, Celery tasks, and full API support.","archived":false,"fork":false,"pushed_at":"2025-06-25T19:11:21.000Z","size":67,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-25T20:18:37.035Z","etag":null,"topics":["celery","celerybeat","django","django-rest-framework","docker","docker-compose","postgresql","redis"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/github-main-user.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-25T18:48:30.000Z","updated_at":"2025-06-25T19:11:24.000Z","dependencies_parsed_at":"2025-06-25T20:18:38.586Z","dependency_job_id":"65e99fcf-8572-4ec8-bf06-3a1ab7e0ab93","html_url":"https://github.com/github-main-user/quick-habit","commit_stats":null,"previous_names":["github-main-user/quick-habit"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/github-main-user/quick-habit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-main-user%2Fquick-habit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-main-user%2Fquick-habit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-main-user%2Fquick-habit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-main-user%2Fquick-habit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/github-main-user","download_url":"https://codeload.github.com/github-main-user/quick-habit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-main-user%2Fquick-habit/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261960448,"owners_count":23236575,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["celery","celerybeat","django","django-rest-framework","docker","docker-compose","postgresql","redis"],"created_at":"2025-06-25T22:08:11.492Z","updated_at":"2026-04-13T03:04:26.046Z","avatar_url":"https://github.com/github-main-user.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Quick Habit\n\nQuick Habit is a simple habit tracker backend inspired by the book *Atomic Habits* by James Clear. It helps users build and maintain healthy routines with the support of Telegram reminders.\n\n## 🚀 Features\n\n- Track both helpful and pleasant habits\n- Link pleasant habits as rewards for completing helpful ones\n- Daily/weekly habit scheduling\n- Telegram integration for habit reminders\n- JWT authentication\n- Pagination, access control, validation rules\n- Background task handling via Celery \u0026 Redis\n- Scheduling tasks via Celery Beat\n- Dockerized for easy deployment\n\n## 🧱 Tech Stack\n\n- Python 3.13\n- Django 5+\n- Django REST Framework\n- PostgreSQL\n- Redis\n- Celery + Celery Beat\n- Docker \u0026 Docker Compose\n\n## 🧪 Running Tests\n\n```bash\ndocker compose run web python manage.py test\n```\n\n## 📬 Telegram Integration\n\nThe app sends habit reminders via Telegram. To enable:\n\n1. Create a Telegram bot via BotFather\n2. Save the bot token in your `.env`\n3. Link your user with a `chat_id`\n4. Celery will handle sending reminders on schedule\n\n\n## 📚 API Documentation\n\nAuto-generated Swagger/Redoc API documentation available at:\n\n```\nhttp://localhost/api/docs/\nhttp://localhost/api/redoc/\n```\n\n## Local Usage\n\nIn case you want to run this project manually on your machine:\n\n### 1. Clone the repo\n\n```bash\ngit clone https://github.com/yourusername/quick-habit.git\ncd quick-habit\n````\n\n### 2. Create `.env` file\n\nCopy `.env.example` to `.env` and configure your variables:\n\n```bash\ncp .env.example .env\n```\n\n### 3. Build and run with Docker\n\n```bash\ndocker compose up --build\n```\n\nApp will be available at `http://localhost:80`\n\nTo stop started containers use `docker compose down`, add `-v` to clean up all volumes.\n\n## Automatic CICD\n\nIn case you want to use automatic CICD via github actions:\n\n1. Set up your server:\n    - Install Docker\n    - Set up SSH\n    - Set up firewall for 22(ssh) and 80(http) ports *(recommended but optional)*\n    - Create a non-root user and add it to the `docker` group *(recommended but optional)*.\n    - Generate a pair of keys using `ssh-keygen` and add the public one to `/home/\u003cyour_user\u003e/.ssh/authorized_keys` on your server.\n2. Fork this repo\n3. Setup github secrets:\n    - `ENV_FILE` - file with all important variables *(see `.env.example` file)*.\n    - `SERVER_IP` - IP address of your server.\n    - `SSH_USER` - user name.\n    - `SSH_SECRET_KEY` - private ssh key.\n\nEvery push/PR will trigger these github actions:\n1. lint (flake8)\n2. test\n3. deploy\n\nApp will be available at `http://\u003cSERVER_IP\u003e:80`\n\nTo stop started application - `cd` to `/home/\u003cSSH_USER\u003e/learning-management/`,\nand run `docker compose down` (add `-v` to clean up all volumes).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub-main-user%2Fquick-habit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgithub-main-user%2Fquick-habit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub-main-user%2Fquick-habit/lists"}