{"id":19815715,"url":"https://github.com/damianoalves/flask-service","last_synced_at":"2025-07-09T08:04:37.386Z","repository":{"id":43735993,"uuid":"131870207","full_name":"damianoalves/flask-service","owner":"damianoalves","description":":globe_with_meridians: A Backend service template project developed with Python Flask ","archived":false,"fork":false,"pushed_at":"2024-10-25T23:49:08.000Z","size":59,"stargazers_count":84,"open_issues_count":2,"forks_count":24,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-09T08:04:34.060Z","etag":null,"topics":["flask-application","flask-restful","flask-sqlalchemy","heroku","jwt-authentication","python","python-3","rest-api"],"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/damianoalves.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":"2018-05-02T15:25:52.000Z","updated_at":"2025-06-28T07:43:51.000Z","dependencies_parsed_at":"2024-06-22T22:30:40.013Z","dependency_job_id":"cf325a56-45f8-4bc2-b164-794705e91c36","html_url":"https://github.com/damianoalves/flask-service","commit_stats":null,"previous_names":["damianoalves/flask-service","damianoalves/flask-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/damianoalves/flask-service","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damianoalves%2Fflask-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damianoalves%2Fflask-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damianoalves%2Fflask-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damianoalves%2Fflask-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/damianoalves","download_url":"https://codeload.github.com/damianoalves/flask-service/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damianoalves%2Fflask-service/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264419452,"owners_count":23605197,"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":["flask-application","flask-restful","flask-sqlalchemy","heroku","jwt-authentication","python","python-3","rest-api"],"created_at":"2024-11-12T10:06:56.822Z","updated_at":"2025-07-09T08:04:37.368Z","avatar_url":"https://github.com/damianoalves.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flask API\n\nThis is a Flask API that I will keep improving with new features and functionalities.\nThis boilerplate can be used as a template for bigger projects.\n\n ## 🔴 I'll start to improve this project again after a couple of years\n\n### Introduction\n\nThe “micro” in microframework means Flask aims to keep the core simple but extensible. Flask won’t make many decisions for you, such as what database to use.\n\nBy convention, templates and static files are stored in subdirectories within the application’s Python source tree, with the names templates and static respectively.\n\n### Dependencies\n\n* [Python](https://www.python.org/) - Programming Language\n* [Flask](https://flask.palletsprojects.com/) - The framework used\n* [SQLAlchemy](https://docs.sqlalchemy.org/) - ORM\n* [Pydantic](https://pydantic-docs.helpmanual.io/) - Data validation\n* [Alembic](https://alembic.sqlalchemy.org/) - Database Migrations\n* [Pip](https://pypi.org/project/pip/) - Dependency Management\n* [RESTful](https://restfulapi.net/) - REST docs\n* [Representational State Transfer](https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm) - Article by Roy Fielding\n\n### Virtual environments\n\n```\n$ sudo apt-get install python-virtualenv\n$ python3 -m venv venv\n$ . venv/bin/activate\n$ pip install Flask\n```\n\nInstall all project dependencies using:\n\n```\n$ pip install -r requirements.txt\n```\n\n### Running\n \n```\n$ export FLASK_APP=app.py\n$ export FLASK_ENV=development\n$ python -m flask run\n```\n\nThis launches a very simple builtin server, which is good enough for testing but probably not what you want to use in production.\n\nIf you enable debug support the server will reload itself on code changes, and it will also provide you with a helpful debugger if things go wrong.\n\nIf you have the debugger disabled or trust the users on your network, you can make the server publicly available simply by adding --host=0.0.0.0 to the command line:\n\n```\nflask run --host=0.0.0.0\n```\n\n### Running using Manager\n\nThis app can be started using Flask Manager. It provides some useful commands and configurations, also, it can be customized with more functionalities.\n\n```\npython manage.py runserver\n```\n\n### Alembic Migrations\n\nUse the following commands to create a new migration file and update the database with the last migrations version:\n\n```\nflask db revision --autogenerate -m \"description here\"\nflask db upgrade head\n```\n\nThis project also uses the customized manager command to perform migrations.\n```\npython manage.py db revision --autogenerate -m \"description here\"\npython manage.py db upgrade head\n```\n\nTo upgrade the database with the newest migrations version, use:\n\n```\npython manage.py db upgrade head\n```\n\nFor more information, access [Auto generating migrations](https://alembic.sqlalchemy.org/en/latest/autogenerate.html).\n\n\n## Contributing\n\nThis API was developed based on:\n\n[Flask documentation](https://flask.palletsprojects.com/)\n\n[REST APIs with Flask and Python](https://www.udemy.com/rest-api-flask-and-python/) \n\n[The Ultimate Flask Course](https://www.udemy.com/the-ultimate-flask-course) \n\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details\n\n## Certificate\n\n\n[Certificate](https://www.udemy.com/certificate/UC-CYMYZILZ/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdamianoalves%2Fflask-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdamianoalves%2Fflask-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdamianoalves%2Fflask-service/lists"}