{"id":24785588,"url":"https://github.com/saifkhan192/docker-flask-api-mongodb-boilerplate","last_synced_at":"2026-04-16T10:36:05.368Z","repository":{"id":195301117,"uuid":"319962066","full_name":"saifkhan192/docker-flask-api-mongodb-boilerplate","owner":"saifkhan192","description":"Docker, Flask, MongoDB, MYSQL, ReactJS and SwaggerUI Ready-to-use API Project Structure","archived":false,"fork":false,"pushed_at":"2020-12-17T17:51:10.000Z","size":3180,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-29T14:19:14.715Z","etag":null,"topics":["flask","mongodb","mysql","reactjs","swaggerui"],"latest_commit_sha":null,"homepage":"","language":"HTML","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/saifkhan192.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}},"created_at":"2020-12-09T13:17:30.000Z","updated_at":"2020-12-21T11:12:41.000Z","dependencies_parsed_at":"2023-09-17T11:35:37.197Z","dependency_job_id":null,"html_url":"https://github.com/saifkhan192/docker-flask-api-mongodb-boilerplate","commit_stats":null,"previous_names":["saifkhan192/docker-flask-api-mongodb-boilerplate"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saifkhan192%2Fdocker-flask-api-mongodb-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saifkhan192%2Fdocker-flask-api-mongodb-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saifkhan192%2Fdocker-flask-api-mongodb-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saifkhan192%2Fdocker-flask-api-mongodb-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saifkhan192","download_url":"https://codeload.github.com/saifkhan192/docker-flask-api-mongodb-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245240764,"owners_count":20583099,"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","mongodb","mysql","reactjs","swaggerui"],"created_at":"2025-01-29T14:19:17.957Z","updated_at":"2026-04-16T10:36:00.340Z","avatar_url":"https://github.com/saifkhan192.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Docker, Flask, MongoDB, MYSQL, ReactJS and SwaggerUI Ready-to-use API Project Structure\n[![Author](http://img.shields.io/badge/author-@saifkhan192-blue.svg)](https://www.linkedin.com/in/saifullah-khan-02318086/)\n\nA ready-to-use boilerplate for REST API Development with Docker, Flask, MongoDB, MYSQL, ReactJS and SwaggerUI\n\n## Features\n\n-   Light-weight project\n-   Basic Authentication, Register/Login pages (http://localhost/login, http://localhost/register)\n-   Example endpoints. for example survey collection and user subscription\n-   Admin section (http://localhost/admin/) with crud operations\n-   Validations included\n-   Email helper added just set `SMTP_ACCOUNT` and use\n-   Mysql raw query + using second db examples are Included\n\n-   Included Swagger Documenation\n-   Two flavours of Swagger Documenation (http://localhost/api/docs1 and http://localhost/api/docs2)\n-   Api Documenation is dynamic, just change application/doc/apidoc.yaml and refresh the doc page\n-   Test cases with pytest\n-   Added support to be deployed to heroku\n-   Added make commands to build/run and bash into the containers\n-   Vscode launch.json is included to do breakpoint debugging, see the details below \n-   To use the flask debugbar uncomment config `DEBUG_TB_PANELS` and `FLASK_DEBUG=TRUE`\n\n-   TODO: JWT token authorization\n-   TODO: Add some MYSQL crud and migrations\n-   TODO: Include CORS\n-   TODO: API collection for Postman.\n-   TODO: Add celery queue for async jobs\n-   TODO: Add social logins for example Google, Facebook etc\n\n\n\n## Project  structure\n```sh\n├── application\n│   ├── auth_app.py\n│   ├── commands.py\n│   ├── doc\n│   │   ├── apidoc.json\n│   │   └── apidoc.yaml\n│   ├── exceptions.py\n│   ├── flask_app.py\n│   ├── flask_app.pyc\n│   ├── fontend_app.py\n│   ├── forms\n│   │   └── auth_forms.py\n│   ├── helper.py\n│   ├── __init__.py\n│   ├── migrations.py\n│   ├── models\n│   │   ├── admin_models.py\n│   │   ├── auth.py\n│   │   ├── __init__.py\n│   │   └── models.py\n│   ├── run_server.py\n│   ├── schemas\n│   │   ├── __init__.py\n│   │   └── UserSchema.py\n│   ├── seeders.py\n│   ├── tasks\n│   │   ├── __init__.py\n│   │   └── user_tasks.py\n│   ├── tests\n│   │   ├── config.py\n│   │   ├── conftest.py\n│   │   ├── pytest.ini\n│   │   ├── test_app.py\n│   │   ├── test_subscriber.py\n│   │   └── test_survey.py\n│   └── wsgi.py\n├── coverage\n├── docker\n│   ├── bash_history.log\n│   ├── docker-compose.yml\n│   ├── DockerfileApp\n│   ├── DockerfileMysql\n│   └── DockerfileNode\n├── gist.gist\n├── gunicorn_starter.sh\n├── img\n│   ├── Screenshot from 2020-12-10 19-20-16.png\n│   ├── Screenshot from 2020-12-10 19-20-50.png\n│   ├── Screenshot from 2020-12-10 19-21-38.png\n│   └── Screenshot from 2020-12-10 19-35-50.png\n├── Makefile\n├── Procfile\n├── react\n│   ├── node_modules\n│   ├── package.json\n│   ├── package-lock.json\n│   ├── src\n│   │   ├── App.jsx\n│   │   ├── containers\n│   │   ├── index.jsx\n│   │   └── services\n│   │       └── Api.jsx\n│   ├── web-dist\n│   │   ├── bundle.js\n│   │   └── bundle.js.map\n│   ├── webpack.config.common.js\n│   ├── webpack.config.dev.js\n│   └── webpack.config.production.js\n├── README.md\n├── requirements.txt\n├── runtime.txt\n├── static\n│   ├── dist\n│   │   ├── bundle.js\n│   │   └── bundle.js.map\n│   ├── swaggerui\n│   │   ├── css\n│   │   │   └── swagger-ui.css\n│   │   ├── img\n│   │   │   ├── favicon-16x16.png\n│   │   │   └── favicon-32x32.png\n│   │   └── js\n│   │       ├── swagger-ui-bundle.js\n│   │       ├── swagger-ui.js\n│   │       └── swagger-ui-standalone-preset.js\n│   ├── swaggerui2\n│   │   └── dist\n│   │       ├── css\n│   │       │   ├── api-explorer.css\n│   │       │   ├── index.css\n│   │       │   ├── print.css\n│   │       │   ├── reset.css\n│   │       │   ├── screen.css\n│   │       │   ├── standalone.css\n│   │       │   └── typography.css\n│   │       ├── lib\n│   │       │   ├── backbone-min.js\n│   │       │   ├── bootstrap.min.js\n│   │       │   ├── handlebars-2.0.0.js\n│   │       │   ├── highlight.7.3.pack.js\n│   │       │   ├── jquery-1.8.0.min.js\n│   │       │   ├── jquery.ba-bbq.min.js\n│   │       │   ├── jquery.slideto.min.js\n│   │       │   ├── jquery.wiggle.min.js\n│   │       │   ├── jsoneditor.js\n│   │       │   ├── marked.js\n│   │       │   ├── swagger-oauth.js\n│   │       │   └── underscore-min.js\n│   │       └── swagger-ui.min.js\n│   └── theme-1\n│       ├── css\n│       │   ├── all.min.css\n│       │   ├── landing_page_style.css\n│       │   └── sb-admin-2.min.css\n│       ├── images\n│       │   └── landing_page\n│       │       ├── 1.jpg\n│       │       ├── 2.jpg\n│       │       ├── 3.jpg\n│       │       ├── 4.jpg\n│       │       └── 5.jpg\n│       └── js\n│           ├── bootstrap.bundle.min.js\n│           ├── jquery.easing.min.js\n│           ├── jquery.min.js\n│           └── sb-admin-2.min.js\n└── templates\n    ├── auth\n    │   ├── layout.html\n    │   ├── login.html\n    │   ├── messages.html\n    │   └── register.html\n    ├── landing_page.html\n    ├── react_page.html\n    ├── swaggerui-theme1.html\n    └── swaggerui-theme2.html\n\n```\n\n## Getting started\n\n```make\ngit clone https://github.com/saifkhan192/docker-flask-api-mongodb-boilerplate.git\ncd docker-flask-api-mongodb-boilerplate\nmake build \u0026\u0026 make run_app\n```\n\n\n\n## Deploy on Heroku\n\n1. Create Heroku account for free (https://signup.heroku.com/\n2. On the dashboard (https://dashboard.heroku.com/apps), select New -\u003e Create new app:\n\u003cimg src=\"./img/Screenshot from 2020-12-10 19-20-16.png\" /\u003e\n\n3. Goto \"Settings\" tab, then click \"Reveal Config Vars\" and add below env vars.\n\u003cimg src=\"./img/Screenshot from 2020-12-10 19-35-50.png\" /\u003e\n\n4. Goto \"Deply\" tab on app details page and \"Connect to GitHub\", then select your github repository\n\u003cimg src=\"./img/Screenshot from 2020-12-10 19-20-50.png\" /\u003e\n\n5. Now click \"Deploy Branch\" and after deploy is completed click \"Open app\" at top right\n\u003cimg src=\"./img/Screenshot from 2020-12-10 19-21-38.png\" /\u003e\n\nDemo here:\nhttps://docker-flask-api-mongodb.herokuapp.com/\n\n\n## Debugging\n-   In vscode add breakpoint at any line and press F5 to start listening by the debugger\n-   Now refresh the page to stop the debugger at the breakpoint\n\n## Tests\n### Running  Test Cases\n\n```bash\nmake run_tests\n```\n\n## Usefull Make Commands\n\n```make\nmake follow_logs #show flask debug output\nmake bash_app #ssh into the app\nmake watch_reactjs_files #monitor reactjs files and compile as files changes\nmake refresh_app #recreate app if flask does not reload on files changes\n```\n\n\n## Bugs or improvements\n\nFeel free to report any bugs or improvements. Pull requests are always welcome.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaifkhan192%2Fdocker-flask-api-mongodb-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaifkhan192%2Fdocker-flask-api-mongodb-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaifkhan192%2Fdocker-flask-api-mongodb-boilerplate/lists"}