{"id":25246846,"url":"https://github.com/godhanded/myflaskstarterplate","last_synced_at":"2026-05-02T03:31:43.874Z","repository":{"id":197194932,"uuid":"698145633","full_name":"Godhanded/MyFlaskStarterPlate","owner":"Godhanded","description":"Boiler plate Template code for Flask Apis with basic setup and helpers","archived":false,"fork":false,"pushed_at":"2023-10-14T09:14:30.000Z","size":14,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T21:31:38.548Z","etag":null,"topics":["api","backend","backend-api","boilerplate-template","flask","python","templates"],"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/Godhanded.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}},"created_at":"2023-09-29T09:02:15.000Z","updated_at":"2023-10-04T08:04:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"5da75f69-5eed-496d-beca-50b7aef9b027","html_url":"https://github.com/Godhanded/MyFlaskStarterPlate","commit_stats":null,"previous_names":["godhanded/myflaskstarterplate"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/Godhanded/MyFlaskStarterPlate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Godhanded%2FMyFlaskStarterPlate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Godhanded%2FMyFlaskStarterPlate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Godhanded%2FMyFlaskStarterPlate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Godhanded%2FMyFlaskStarterPlate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Godhanded","download_url":"https://codeload.github.com/Godhanded/MyFlaskStarterPlate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Godhanded%2FMyFlaskStarterPlate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32522245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-02T01:12:54.858Z","status":"online","status_checked_at":"2026-05-02T02:00:05.923Z","response_time":132,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["api","backend","backend-api","boilerplate-template","flask","python","templates"],"created_at":"2025-02-12T02:49:59.252Z","updated_at":"2026-05-02T03:31:43.827Z","avatar_url":"https://github.com/Godhanded.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sample ReadMe\n\n## Table Of Contents\n- [Set up for Local Machine](#set-up-the-server)\n- [Base Uri/Live Deployment](#base-uri)\n- [Error Handling](#error-handling)\n- [Permissions/Roles](#permissionsroles)\n- [EndPoints](#endpoints)\n  - [Authentication Routes](#authentication)\n- [Authors](#authors)\n- [Acknowledgments](#acknowledgments)\n\n## This boiler plate supports the following extensions setup and ready to use\n| extension  | Usecase |\n|-----------|-----------|\n| - bcrypt | password hashing|\n| - black | code formating|\n| - cryptography| encryption|\n| - email-validator | validate emails|\n| - flask-bcrypt |password hashing |\n| - flask-blueprint| Modules |\n| - flask-caching|caching |\n| - flask-cors | cross origin |\n| - flask-limiter| rate limiting|\n| - flask-mail|send mails|\n| - flask-migrate|data base migrations|\n| - flask-session |loggin. server side sessions |\n| - flask-sqlalchemy|database orm |\n| - gunicorn | production server|\n| - pydantic| input type checking |\n| - python-dotenv |environment variables|\n| - redis | caching|\n| - requests| external requests|\n\n\n## **Api Name API-ENDPOINT DOCUMENTATION**\n---\n\u003cbr\u003e\n\u003cbr\u003e\n\n### **Set up the server**\n#### Install Dependencies\n```bash\n$ python3 -m venv venv\n\n$ source venv/bin/activate\n\n$ pip install -r requirements.txt\n```\n#### if you use pipenv\n\n```bash\n$ pip install pipenv\n\n# create virtuel environment\n$ pipenv --python 3.10\n\n# Activate virtual env\n$ pipenv shell\n\n# install dependencies in requirements.txt or pipfile\n$ pipenv install\n```\n\n#### Set up the Database\n\nWith Postgres running, create a `dbname` database:\n\n```bash\n$ createdb dbname\n```\n#### Add env Variables\ncreate .env file and add variables as in [sample.env](sample.env)\n\n#### Run the Server\n```bash\n$ python3 run.py \n```\n\n### **Base Uri**\n----\n----\ntemporarily hosted for live testing on **https://baseuri**\n....\n\n\n\u003cbr\u003e\n\n### **Error Handling**\n---\n---\n\u003eErrors are returned as JSON objects in the following format with their error code\n\n```json\n{\n  \"error\": \"error name\",\n  \"message\": \"error description\"\n}\n```\nThe API will return 5 error types, with diffreent descriptions when requests fail;\n- 400: Request unprocessable\n- 403: Forbidden\n- 404: resource not found\n- 422: Bad Request\n- 429: Too Many Requests(rate limiting)\n- 500: Internal server error\n\n\u003cbr\u003e\n\n### **Permissions/Roles**\n---\n---\n\n\n\n### **EndPoints**\n---\n---\n\u003cbr\u003e\n\n#### **AUTHENTICATION**\n  \u003e server side authentication is Used\n\n  `POST '/auth/register'`\n\n- Register new user,\n- Request Arguements: JSON object containing\n```json\n{\n  \"email\":\"user email\",\n  \"user_name\":\"user name\",\n  \"password\":\"password at least 8 characters\",\n  \"confirm_password\":\"confirm password\",\n  \"api_key\":\"User Binance account api key\",\n  \"api_secret\":\"User Bianance account api secret\"\n}\n```\n- Returns `message` ,`user name` and `email`\n```json\n{\n    \"message\": \"Success\", \n    \"user_name\": \"user_name\", \n    \"email\": \"user email\"\n}\n```\n---\n\u003cbr\u003e\n\n  `GET '/auth/activate/${token}'`\n- Activates user account\n- Request Arguements: `token`- string jwt code\n- Returns: JSON object containing\n```json\n{\n    \"message\": \"Success\",\n    \"user_name\":\"user_name\",\n    \"is_active\": \"boolean account is active or not\",\n}\n```\n\n---\n\u003cbr\u003e\n\n\n\n\n## Authors\n- [@Godhanded](https://github.com/Godhanded)\n\n## Acknowledgments\n\n- Binance-Python-Connector\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodhanded%2Fmyflaskstarterplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgodhanded%2Fmyflaskstarterplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodhanded%2Fmyflaskstarterplate/lists"}