{"id":30061546,"url":"https://github.com/fidelisaboke/budgetron-api","last_synced_at":"2026-05-15T13:34:45.388Z","repository":{"id":308307491,"uuid":"998728248","full_name":"Fidelisaboke/budgetron-api","owner":"Fidelisaboke","description":"A RESTful API for efficient finance management and record keeping.","archived":false,"fork":false,"pushed_at":"2025-08-07T15:45:18.000Z","size":63,"stargazers_count":1,"open_issues_count":6,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-31T16:45:09.314Z","etag":null,"topics":["budget-app","flask","flask-restful","flask-sqlalchemy"],"latest_commit_sha":null,"homepage":"https://budgetron-api.onrender.com","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/Fidelisaboke.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-09T06:43:33.000Z","updated_at":"2025-08-07T15:45:22.000Z","dependencies_parsed_at":"2025-08-05T09:36:04.727Z","dependency_job_id":null,"html_url":"https://github.com/Fidelisaboke/budgetron-api","commit_stats":null,"previous_names":["fidelisaboke/budgetron-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Fidelisaboke/budgetron-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fidelisaboke%2Fbudgetron-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fidelisaboke%2Fbudgetron-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fidelisaboke%2Fbudgetron-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fidelisaboke%2Fbudgetron-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Fidelisaboke","download_url":"https://codeload.github.com/Fidelisaboke/budgetron-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fidelisaboke%2Fbudgetron-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33068616,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-15T11:35:32.926Z","status":"ssl_error","status_checked_at":"2026-05-15T11:35:31.362Z","response_time":103,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["budget-app","flask","flask-restful","flask-sqlalchemy"],"created_at":"2025-08-08T02:24:15.814Z","updated_at":"2026-05-15T13:34:45.368Z","avatar_url":"https://github.com/Fidelisaboke.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Budgetron API\n## Project Overview\nBudgetron API is a RESTful service for a web-based personal finance management application, allowing users to categorize transactions, create monthly \nbudgets, and generate downloadable reports.\n\n## Table of Contents\n- [Features](#features)\n- [Tech Stack](#tech-stack)\n- [Installation and Setup](#installation-and-setup)\n  - [Pre-requisites](#pre-requisites)\n  - [Setup Instructions](#setup-instructions)\n- [Usage](#usage)\n- [Project Structure](#project-structure)\n- [API Documentation](#api-documentation)\n\n## Features\n- JWT Authentication (Register, Login, Profile)\n- Category Management (Income/Expense)\n- Transaction Tracking\n- Budget Creation and Monitoring\n- Monthly Financial Report Generation (.csv)\n- Pagination, Filtering, and Admin Access\n\n## Tech Stack\n- **Backend:** Python (Flask + Flask-RESTful)\n- **Database:** PostgreSQL\n- **ORM:** SQLAlchemy + Flask-Migrate\n- **Auth:** JWT (via `flask-jwt-extended`)\n- **Serialization**: Marshmallow\n- **Docs:** Postman Collection\n\n## Installation and Setup\n### Pre-requisites\n- Python 3.12 or above\n\n### Setup Instructions\n- Clone the repository:\n```bash\ngit clone https://github.com/Fidelisaboke/budgetron.git\ncd budgetron\n```\n\n- Create a virtual environment:\n```bash\npython3 -m venv .venv\n```\n\n- Activate the virtual environment:\n    - On Windows:\n    ```bash\n    .venv\\Scripts\\activate\n    ```\n    - on macOS or Linux:\n    ```bash\n    source .venv/bin/activate\n    ```\n\n- Install dependencies:\n```bash\npip install -r requirements.txt\n```\n\n- Copy environment example files:\n```bash\ncp .env.example .env\ncp .flaskenv.example .flaskenv  # Optional but useful for Flask CLI\n```\n\n- Create `migrations/` directory if not present in the project:\n```bash\nflask db init\n```\n\n- Create and apply migrations:\n```bash\nflask db migrate -m \"Initial\"\nflask db upgrade\n```\n\n- Seed the database with initial data:\n```bash\nflaask seed\n```\n\n- Create an admin user account:\n```bash\nflask create-admin\n```\n\n## Usage\n- Run the application:\n```bash\nflask run\n```\nRuns the server at `http://127.0.0.1:5000`\n\n## Project Structure\n```bash\n.\n├── app.py                  # Entry point for the Flask application\n├── budgetron/              # Main application package\n│   ├── __init__.py         # App factory\n│   ├── config.py           # Configuration settings\n│   ├── models.py           # SQLAlchemy models\n│   ├── resources/          # API route handlers (Flask-RESTful)\n│   ├── schemas/            # Marshmallow schemas for validation/serialization\n│   ├── services/           # Business logic (e.g., report generation)\n│   ├── utils/              # Utility functions (logging, JWT, pagination, etc.)\n│   ├── templates/          # Jinja templates (if any)\n│   ├── commands/           # Custom Flask CLI commands\n│   └── seeder/             # Data seeders for roles and initial data\n├── migrations/             # Alembic migrations for DB schema management\n├── requirements.txt        # List of Python dependencies\n├── .env.example            # Environment variable sample file\n├── .flaskenv.example       # Flask-specific environment config\n├── .gitignore              # Files and directories to exclude from Git\n├── README.md               # Project documentation\n\n```\n\n## API Documentation\nExplore all available endpoints using the official Postman Collection:\n- [Postman Collection](https://documenter.getpostman.com/view/31418538/2sB2xFenjK)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffidelisaboke%2Fbudgetron-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffidelisaboke%2Fbudgetron-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffidelisaboke%2Fbudgetron-api/lists"}