{"id":16347179,"url":"https://github.com/zenithclown/flask-docker-template","last_synced_at":"2026-04-09T07:06:05.347Z","repository":{"id":37980440,"uuid":"378717216","full_name":"ZenithClown/flask-docker-template","owner":"ZenithClown","description":"Template for Flask and Docker","archived":false,"fork":false,"pushed_at":"2024-05-06T21:24:03.000Z","size":329,"stargazers_count":0,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-28T06:09:56.304Z","etag":null,"topics":["dependabot","docker","docker-compose","dockerignore","dotenv","flake8","flask","flask-restful","gitattributes","github-actions","gitignore","python","rest-api","template","templates"],"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/ZenithClown.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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},"funding":{"github":["ZenithClown"]}},"created_at":"2021-06-20T18:45:05.000Z","updated_at":"2023-05-08T14:46:30.000Z","dependencies_parsed_at":"2024-11-07T11:47:35.910Z","dependency_job_id":"b623cb2e-f40e-415a-ba35-6c5337577384","html_url":"https://github.com/ZenithClown/flask-docker-template","commit_stats":null,"previous_names":[],"tags_count":9,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZenithClown%2Fflask-docker-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZenithClown%2Fflask-docker-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZenithClown%2Fflask-docker-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZenithClown%2Fflask-docker-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ZenithClown","download_url":"https://codeload.github.com/ZenithClown/flask-docker-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239565664,"owners_count":19660158,"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":["dependabot","docker","docker-compose","dockerignore","dotenv","flake8","flask","flask-restful","gitattributes","github-actions","gitignore","python","rest-api","template","templates"],"created_at":"2024-10-11T00:40:10.634Z","updated_at":"2025-11-09T02:30:28.773Z","avatar_url":"https://github.com/ZenithClown.png","language":"Python","funding_links":["https://github.com/sponsors/ZenithClown"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align = \"center\"\u003e\n\tFlask Template \u003cbr\u003e\n\t\u003csub\u003e\u003cb\u003e\u003ci\u003e(python, docker, rest-api, flake8)\u003c/i\u003e\u003c/b\u003e\u003c/sub\u003e \u003cbr\u003e\n\t\u003ca href = \"https://www.linkedin.com/in/dpramanik/\"\u003e\u003cimg height=\"16\" width=\"16\" src=\"https://unpkg.com/simple-icons@v3/icons/linkedin.svg\"/\u003e\u003c/a\u003e\n\t\u003ca href = \"https://github.com/ZenithClown\"\u003e\u003cimg height=\"16\" width=\"16\" src=\"https://unpkg.com/simple-icons@v3/icons/github.svg\"/\u003e\u003c/a\u003e\n\t\u003ca href = \"https://gitlab.com/ZenithClown/\"\u003e\u003cimg height=\"16\" width=\"16\" src=\"https://unpkg.com/simple-icons@v3/icons/gitlab.svg\"/\u003e\u003c/a\u003e\n\t\u003ca href = \"https://www.researchgate.net/profile/Debmalya_Pramanik2\"\u003e\u003cimg height=\"16\" width=\"16\" src=\"https://unpkg.com/simple-icons@v3/icons/researchgate.svg\"/\u003e\u003c/a\u003e\n\t\u003ca href = \"https://www.kaggle.com/dPramanik/\"\u003e\u003cimg height=\"16\" width=\"16\" src=\"https://unpkg.com/simple-icons@v3/icons/kaggle.svg\"/\u003e\u003c/a\u003e\n\t\u003ca href = \"https://app.pluralsight.com/profile/Debmalya-Pramanik/\"\u003e\u003cimg height=\"16\" width=\"16\" src=\"https://unpkg.com/simple-icons@v3/icons/pluralsight.svg\"/\u003e\u003c/a\u003e\n\t\u003ca href = \"https://stackoverflow.com/users/6623589/\"\u003e\u003cimg height=\"16\" width=\"16\" src=\"https://unpkg.com/simple-icons@v3/icons/stackoverflow.svg\"/\u003e\u003c/a\u003e\n\t\u003cbr\u003e\n\t\u003ca href=\"https://github.com/ZenithClown/flask-docker-template/issues\"\u003e\u003cimg alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/ZenithClown/flask-docker-template?style=plastic\"\u003e\u003c/a\u003e\n\t\u003ca href=\"https://github.com/ZenithClown/flask-docker-template/network\"\u003e\u003cimg alt=\"GitHub forks\" src=\"https://img.shields.io/github/forks/ZenithClown/flask-docker-template?style=plastic\"\u003e\u003c/a\u003e\n\t\u003ca href=\"https://github.com/ZenithClown/flask-docker-template/stargazers\"\u003e\u003cimg alt=\"GitHub stars\" src=\"https://img.shields.io/github/stars/ZenithClown/flask-docker-template?style=plastic\"\u003e\u003c/a\u003e\n\t\u003ca href=\"https://github.com/ZenithClown/flask-docker-template/blob/master/LICENSE\"\u003e\u003cimg alt=\"GitHub license\" src=\"https://img.shields.io/github/license/ZenithClown/flask-docker-template?style=plastic\"\u003e\u003c/a\u003e\n\t\u003ca href=\"https://app.travis-ci.com/ZenithClown/flask-docker-template.svg?branch=master\"\u003e\u003cimg alt=\"Travis CI Build\" src=\"https://app.travis-ci.com/ZenithClown/flask-docker-template.svg?branch=master\"\u003e\u003c/a\u003e\u003csup\u003e\u003cb\u003e*\u003c/b\u003e\u003c/sup\u003e\n\u003c/h1\u003e\n\n\u003cp align = \"justify\"\u003eA simple \u003ci\u003eflask-template\u003c/i\u003e for REST-API design and implementation. Please include the \u003ca href = \"https://github.com/ZenithClown/flask-docker-template/tree/master\"\u003eTemplate Link\u003c/a\u003e in your design. Template includes \u003ccode\u003e.gitignore\u003c/code\u003e and \u003ccode\u003e.gitattributes\u003c/code\u003e related to python and flask-api model. You can also update/change/delete \u003ccode\u003eLICENSE\u003c/code\u003e as required. Other files are related to \u003ccode\u003edocker\u003c/code\u003e and \u003ccode\u003eflake8\u003c/code\u003e (code linting) is included with basic setup. The template is built on GitHub, thus \u003ccode\u003e.github\u003c/code\u003e directory is included with issue template, and workflows directory.\u003c/p\u003e\n\n**NOTE:** some optional usage, specifications, and helpful links are as below:\n  1. You can add GitHub Repository Badges from [Shields IO](https://shields.io/) - if this is a Public Repository;\n  2. TAB (size = 4) has been used for indentation.\n  3. `.github/workflows` is added however, it is recomended that you create your own workflows either using **GitHub Actions** or on your own.\n  4. Basic `docker` files are added for convention, modify it as per requirement. Recomended to delete the file, if not required.\n  5. The repository uses `markdown` instead of `rich text format`, so make necessary changes to file extension/type as required.\n  6. [Engine Configuration](https://docs.sqlalchemy.org/en/14/core/engines.html) for SQLAlchemy Documentation.\n\n## Quick Start Guide\n\u003cp align = \"justify\"\u003eIntroduced in 2019, users can now create a repository from templates in GitHub. To do this, simply head over to any repository settings and enable \"Template Repository\" from the Options Menu. When creating a \u003ci\u003enew repository\u003c/i\u003e from this template, you can just click on \u003cb\u003e\u003ccode\u003eUse this template\u003c/code\u003e\u003c/b\u003e available in this repository (refer the picture below).\u003c/p\u003e\n\n\u003cimg alt = \"use_this_template_demo\" src = \"./assets/use_this_template_demo.png\"\u003e\n\n### Creating a NEW Repository from Template\n\u003cp align = \"justify\"\u003eTemplate Repository is not limited to GitHub, and you can setup your own local-file structure for the same. The following describes the usage of \u003ccode\u003ersync\u003c/code\u003e which is available in most linux distros, \u003ca href = \"https://linux.die.net/man/1/rsync\"\u003emore information on rsync\u003c/a\u003e.\u003c/p\u003e\n\n```bash\n# Note the use of rsync\nrsync -rh ~/source/directory /destination/directory\n```\n\n### Generate Template using `cookiecutter`\n\u003cp align = \"justify\"\u003e\u003ca href = \"https://cookiecutter.readthedocs.io/en/1.7.3/README.html\"\u003ecookiecutter\u003c/a\u003e is an excellet module for creating projects from templates. The process can be done so locally (as shown below), or using command line utility \u003ccode\u003ecookiecutter https://github.com/ZenithClown/flask-docker-template/tree/cookiecutter\u003c/code\u003e by directly accesing the repository from GitHub.\u003c/p\u003e\n\n\u003cimg alt = \"using_cookiecutter_locally_demo\" src = \"./assets/cookiecutter.png\"\u003e\n\n## Setup Information\n\u003cp align = \"justify\"\u003eConfigure the application by setting \u003ccode\u003eENVIRONMENT VARIABLES\u003c/code\u003e as required. Sample variables are provided in \u003ccode\u003e.env.bkp\u003c/code\u003e, however for production grade application is is recomended that you set them at \u003ccode\u003e$PATH\u003c/code\u003e. Start the application using \u003ccode\u003epython manage.py\u003c/code\u003e which serves the port \u003ccode\u003e0.0.0.0:5000\u003c/code\u003e by default.\u003c/p\u003e\n\n---\n\n\u003cp align = \"justify\"\u003e\u003cb\u003e*\u003c/b\u003e Travis CI allows only 10k Credits on free-tier. The build might be old, please re-enable and check service if required.\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzenithclown%2Fflask-docker-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzenithclown%2Fflask-docker-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzenithclown%2Fflask-docker-template/lists"}