{"id":28353347,"url":"https://github.com/tingeytime/budgettool","last_synced_at":"2026-02-14T10:33:14.320Z","repository":{"id":295507394,"uuid":"990281442","full_name":"TingeyTime/budgetTool","owner":"TingeyTime","description":"A personal budgeting tool with a database, API, and frontend","archived":false,"fork":false,"pushed_at":"2025-05-27T04:10:32.000Z","size":28,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-09T23:38:13.807Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/TingeyTime.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-05-25T21:30:28.000Z","updated_at":"2025-05-27T04:10:35.000Z","dependencies_parsed_at":"2025-06-21T20:42:12.497Z","dependency_job_id":null,"html_url":"https://github.com/TingeyTime/budgetTool","commit_stats":null,"previous_names":["tingeytime/budgettool"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/TingeyTime/budgetTool","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TingeyTime%2FbudgetTool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TingeyTime%2FbudgetTool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TingeyTime%2FbudgetTool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TingeyTime%2FbudgetTool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TingeyTime","download_url":"https://codeload.github.com/TingeyTime/budgetTool/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TingeyTime%2FbudgetTool/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29442749,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-14T10:17:46.583Z","status":"ssl_error","status_checked_at":"2026-02-14T10:17:22.534Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2025-05-28T01:09:16.342Z","updated_at":"2026-02-14T10:33:14.304Z","avatar_url":"https://github.com/TingeyTime.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Budget Tool\n\nA full-stack personal budgeting application designed to help you manage your finances effectively. This tool provides expense tracking, budget planning, and financial reporting capabilities through an intuitive web interface.\n\n## ✨ Key Features\n\n* **Expense Tracking:** Easily record and categorize your daily expenses\n* **Budget Planning:** Set and manage monthly budgets by category\n* **Financial Reports:** Generate visual reports and insights about your spending habits\n* **Data Export:** Export your financial data in various formats (CSV, PDF)\n\n## 🚀 Technologies\n\n* **Frontend:** [Streamlit](https://streamlit.io/) - For building interactive data apps and dashboards.\n* **API:** [FastAPI](https://fastapi.tiangolo.com/) - A modern, fast (high-performance) web framework for building APIs with Python 3.7+ based on standard Python type hints.\n* **Database:** [PostgreSQL](https://www.postgresql.org/) - A powerful, open-source object-relational database system.\n\n## 📁 Project Structure\n\nThe project is organized into the following directories:\n\n* `./api/`: Contains the FastAPI application, handling all business logic and data interactions.\n* `./db/`: Contains PostgreSQL-related configurations, potentially including schema definitions and initial data scripts.\n* `./frontend/`: Contains the Streamlit application, providing the user interface.\n\nEach of these directories includes its own `Dockerfile` for containerization during development.\n\n## 📦 Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes. The setup process typically takes about 10-15 minutes.\n\n### Prerequisites\n\nEnsure you have the following installed:\n\n* [Docker Desktop](https://www.docker.com/products/docker-desktop/) (v20.10.0 or higher)\n* [Make](https://www.gnu.org/software/make/) (v4.0 or higher)\n* At least 2GB of free RAM for running all services\n\n### Environment Variables\n\nThis project uses a `.env` file to manage environment variables for database credentials and service ports.\n\n1.  **Create a `.env` file:** In the **root directory** of the project, create a file named `.env`.\n\n2.  **Add the following variables:** Copy the content below into your newly created `.env` file. Replace the placeholder values with your desired settings.\n\n    ```env\n    # Database Configuration\n    POSTGRES_DB=your_database_name\n    POSTGRES_USER=your_db_user\n    POSTGRES_PASSWORD=your_db_password\n    DB_HOST=db # This should match the service name in docker-compose.yml\n\n    # Service Ports\n    FRONTEND_PORT=8501\n    API_PORT=8000\n    ```\n\n    **Important:** Do **not** commit your `.env` file to version control. It should be ignored by Git (add `.env` to your `.gitignore` file).\n\n\n### Development Setup\n\n1.  **Clone the repository:**\n\n2.  **Build and run the services with Docker Compose:**\n    The `docker-compose.yml` in the root directory will orchestrate the startup of all services (database, API, and frontend).\n\n    ```bash\n    make preview\n    ```\n    This command will:\n    * Build the Docker images for the `api` and `frontend` services (if not already built or changes detected).\n    * Start the PostgreSQL database container.\n    * Start the FastAPI service.\n    * Start the Streamlit frontend service.\n\n3.  **Access the applications:**\n    Once all services are up and running, you can access them at the following URLs:\n\n    * **Streamlit Frontend:** `http://localhost:8501` (default Streamlit port)\n    * **FastAPI Documentation (Swagger UI):** `http://localhost:8000/docs` (default FastAPI port)\n\n## 🛠️ Development Workflow\n\n* **API Development:** Make changes within the `api/` directory. FastAPI will typically auto-reload with `uvicorn` if configured within its Dockerfile or entrypoint script.\n* **Frontend Development:** Make changes within the `frontend/` directory. Streamlit applications will auto-reload when file changes are detected.\n* **Database Migrations:** (Future enhancement) Implement a proper migration strategy (e.g., Alembic for FastAPI) for managing database schema changes.\n\n## 🔒 Security\n\nFor security concerns or vulnerability reports, please create an issue with the \"security\" label or contact the maintainers directly.\n\n## 🙏 Acknowledgments\n\n* Thanks to all contributors who have helped shape this project","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftingeytime%2Fbudgettool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftingeytime%2Fbudgettool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftingeytime%2Fbudgettool/lists"}