{"id":14065258,"url":"https://github.com/choyiny/flask-api-starter","last_synced_at":"2025-07-29T20:31:54.130Z","repository":{"id":45122424,"uuid":"225972325","full_name":"choyiny/flask-api-starter","owner":"choyiny","description":"Boilerplate for building REST APIs in Flask","archived":true,"fork":false,"pushed_at":"2022-01-06T22:43:58.000Z","size":70,"stargazers_count":10,"open_issues_count":1,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-08-13T07:08:30.178Z","etag":null,"topics":["boilerplate","flask","flask-apis","flask-blueprints","flask-restful","hacktoberfest","template"],"latest_commit_sha":null,"homepage":"","language":"Python","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/choyiny.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}},"created_at":"2019-12-04T22:57:54.000Z","updated_at":"2024-04-11T03:51:11.000Z","dependencies_parsed_at":"2022-09-02T23:10:21.419Z","dependency_job_id":null,"html_url":"https://github.com/choyiny/flask-api-starter","commit_stats":null,"previous_names":[],"tags_count":7,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/choyiny%2Fflask-api-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/choyiny%2Fflask-api-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/choyiny%2Fflask-api-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/choyiny%2Fflask-api-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/choyiny","download_url":"https://codeload.github.com/choyiny/flask-api-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228046118,"owners_count":17861101,"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":["boilerplate","flask","flask-apis","flask-blueprints","flask-restful","hacktoberfest","template"],"created_at":"2024-08-13T07:04:23.610Z","updated_at":"2024-12-04T04:30:55.837Z","avatar_url":"https://github.com/choyiny.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# Boilerplate for Flask APIs\nA skeleton Flask API only application to quickstart development.\n\n## Features\n- Uses [Flask Blueprints](https://flask.palletsprojects.com/en/1.1.x/blueprints/) for module separation\n- ORM-ready with mongoengine and MongoDB.\n- Fully dockerized and deployment ready\n- [CORS](https://flask-cors.readthedocs.io/en/latest/) protected\n- Integrates with [Marshmallow](https://flask-marshmallow.readthedocs.io/en/latest/)\n- [Sentry](https://sentry.io/) Integration\n- Documentation generated with [Flask-APISpec](https://github.com/jmcarp/flask-apispec/)\n- [Celery](http://www.celeryproject.org/) worker queue support.\n\n## Deployment\n`Dockerfile` is ready for deployment.\nIt is recommended to reverse proxy through nginx.\n\n## Development\n### Setup\n\nNote: This project *requires* Python 3.7+ installed. For Mac users, ensure you are using the correct version of Python because the OS preinstalls Python 2.7 and default `pip` and `python` commands execute in v2.7 rather than v3.x.\n\n1. Clone this repo or create a new one with this as a template.\n\n1. Create a virtual environment for the project and activate it. Run `pip3 install virtualenv` if virtualenv is not installed on Python3.7+\n    ```\n    $ cd flask-api-starter  # or your repo name\n    $ virtualenv venv --python=python\n    $ source venv/bin/activate\n    ```\n\n4. Install the required dependencies, and setup automatic code quality checking with `black`.\n    ```\n    (flask-starter-venv) $ pip install -r requirements.txt\n    (flask-starter-venv) $ pip install -r requirements-dev.txt\n    (flask-starter-venv) $ pre-commit install\n    ```\n\n5. Edit `config.py.bak` with the proper credentials and move it to `config.py`.\n6. Run Migrations\n    ```\n    (flask-starter-venv) $ flask db upgrade\n    ```\n    \n### Run Locally\nRemember to fill any necessary fields in `config.py`.\n1. Make sure you are in your virtualenv that you setup\n    ```\n    $ source flask-starter-venv/bin/activate\n    ```\n2. Start server\n    ```\n    (flask-starter-venv) $ flask run\n    ```\n3. Start Celery worker\n    ```\n    (flask-starter-venv) $ celery worker -A worker.celery --loglevel=info\n    ```\n    \n### Setting up Blueprints\nFlask blueprints are like modules. To create a new one, you can copy the example blueprint, and modify the `__init__.py`\nto change the prefix url. Ensure that it is also included in `app.py`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchoyiny%2Fflask-api-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchoyiny%2Fflask-api-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchoyiny%2Fflask-api-starter/lists"}