{"id":24297913,"url":"https://github.com/sharafatkarim/metro-api","last_synced_at":"2026-01-30T19:32:21.344Z","repository":{"id":259953223,"uuid":"871895952","full_name":"SharafatKarim/metro-api","owner":"SharafatKarim","description":"Metro-API, a lightweight, user-friendly backend for handling user balances. Easily recharge, discharge, and manage user data with a powerful FastAPI framework.","archived":false,"fork":false,"pushed_at":"2024-11-26T15:56:02.000Z","size":24,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-16T20:48:22.785Z","etag":null,"topics":["backend-api","fastapi","python"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SharafatKarim.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2024-10-13T08:45:57.000Z","updated_at":"2024-11-29T18:46:20.000Z","dependencies_parsed_at":"2024-10-28T19:52:13.003Z","dependency_job_id":"64727efc-95eb-4e1b-b07f-338335f73222","html_url":"https://github.com/SharafatKarim/metro-api","commit_stats":null,"previous_names":["sharafatkarim/metro-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SharafatKarim%2Fmetro-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SharafatKarim%2Fmetro-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SharafatKarim%2Fmetro-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SharafatKarim%2Fmetro-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SharafatKarim","download_url":"https://codeload.github.com/SharafatKarim/metro-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242180029,"owners_count":20085086,"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":["backend-api","fastapi","python"],"created_at":"2025-01-16T20:36:13.602Z","updated_at":"2026-01-30T19:32:21.337Z","avatar_url":"https://github.com/SharafatKarim.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚇 Metro-API\n\nWelcome to **Metro-API**, a lightweight, user-friendly backend for handling user balances. Easily recharge, discharge, and manage user data with a powerful FastAPI framework.\n\n![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge\u0026logo=fastapi)\n![Python](https://img.shields.io/badge/Python-3776AB?style=for-the-badge\u0026logo=python)\n![SQLAlchemy](https://img.shields.io/badge/SQLAlchemy-CA2430?style=for-the-badge\u0026logo=python)\n\n## 🚀 Features\n\n- 📋 **User management**: Create, read, update, and delete users.\n- 💰 **Balance management**: Recharge or discharge user balances with ease.\n- 🔄 **SQLAlchemy Integration**: Seamlessly handle database operations.\n- 🏗️ **FastAPI-based**: Blazing fast, easy-to-use REST API.\n\n## ⚡ Quick Setup\n\n### 1. Clone the Repo\n\n```bash\ngit clone https://github.com/SharafatKarim/metro-api.git\n```\n\n### 2. Navigate to the directory\n\n```bash\ncd metro-api\n```\n\n### 3. Deploy on system (Linux)\n\n```bash\nbash setup.sh\n```\n\n#### 3.1 Manual Setup\n\nIf automatic setup (`setup.sh`), you can manually set up the project.\n\n##### 3.1.1 Create a virtual environment\n\n```bash\npython -m venv .venv\n```\n\n##### 3.1.2 Activate the virtual environment\n\n```bash\nsource .venv/bin/activate\n```\n\n##### 3.1.3 Install the required dependencies\n\n```bash\npip install -r requirements.txt\n```\n\n##### 3.1.4 And run the server\n\n```bash\nuvicorn main:app --reload\n```\n\n### 4. Start the API\n\nOnce the setup is complete, the server will start automatically. Visit:\n\n- \u003chttp://127.0.0.1:8000/\u003e (It will redirect to `/docs`)\n\n\u003e Or, check the video guide,\n\u003e [![Screenshot_20241013_154234](https://github.com/user-attachments/assets/1143b791-77dd-44bc-8e48-e51e986542c0)](https://youtu.be/UHvnPYXTJ3U)\n\n## 📂 Endpoints Overview\n\n- `GET /users/{id}` - Retrieve user balance\n- `POST /users` - Create a new user\n- `PUT /users/+/id` - Recharge balance\n- `PUT /users/-/id` - Discharge balance\n- `DELETE /users/{id}` - Delete a user\n\n## 👥 Contributors\n\n[![SharafatKarim's Profilator](https://profilator.deno.dev/SharafatKarim?v=1.0.0.alpha.4)](https://github.com/SharafatKarim)\n[![sadman2084's Profilator](https://profilator.deno.dev/sadman2084?v=1.0.0.alpha.4)](https://github.com/sadman2084)\n\n## 📜 License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n\u003e Enjoy using Metro-API! ✨\n\u003e This `README.md` file is concise and highlights the essential aspects of the project, providing a smooth start for users. Let me know if you'd like to tweak anything!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharafatkarim%2Fmetro-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsharafatkarim%2Fmetro-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharafatkarim%2Fmetro-api/lists"}