{"id":16174951,"url":"https://github.com/app-generator/sample-flask-mongo","last_synced_at":"2025-07-19T00:35:08.396Z","repository":{"id":64016645,"uuid":"571123320","full_name":"app-generator/sample-flask-mongo","owner":"app-generator","description":"Flask \u0026 Mongo - Open-Source Sample | AppSeed","archived":false,"fork":false,"pushed_at":"2022-12-11T07:58:06.000Z","size":6610,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-12T19:20:37.972Z","etag":null,"topics":["appseed","flask","flask-mongodb","mongo","open-source"],"latest_commit_sha":null,"homepage":"https://blog.appseed.us/flask-mongodb-material-kit/","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/app-generator.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-11-27T08:33:59.000Z","updated_at":"2024-08-28T04:16:35.000Z","dependencies_parsed_at":"2023-01-26T18:46:07.707Z","dependency_job_id":null,"html_url":"https://github.com/app-generator/sample-flask-mongo","commit_stats":null,"previous_names":[],"tags_count":3,"template":true,"template_full_name":"app-generator/flask-material-kit","purl":"pkg:github/app-generator/sample-flask-mongo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fsample-flask-mongo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fsample-flask-mongo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fsample-flask-mongo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fsample-flask-mongo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/app-generator","download_url":"https://codeload.github.com/app-generator/sample-flask-mongo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fsample-flask-mongo/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265863793,"owners_count":23840888,"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":["appseed","flask","flask-mongodb","mongo","open-source"],"created_at":"2024-10-10T04:43:49.457Z","updated_at":"2025-07-19T00:35:08.332Z","avatar_url":"https://github.com/app-generator.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Flask \u0026 Mongo](https://github.com/app-generator/sample-flask-mongo) `sample`\n\n`Open-Source` seed project generated by AppSeed in **Flask** Framework on top of **[Material Kit](https://appseed.us/product/material-kit/flask/)** design. Designed for those who like bold elements and beautiful websites, **Material Kit 2** is ready to help you create stunning websites and web apps. `Material Kit 2` is built with over 60 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.\n\n- 👉 [Flask Material Kit](https://flask-material-kit.appseed-srv1.com/) - `LIVE App`\n- 🚀 [Support](https://appseed.us/support/) - via `Email` \u0026 `Discord`\n\n\u003cbr /\u003e\n\n\u003e Features:\n\n- ✅ `Up-to-date dependencies`\n- ✅ Persistence: `Mongo`\n  - learn [how to set up Mongo \u0026 Flask](./README_mongo.md) \n- ✅ DB Tools: `Flask-MongoEngine`\n- ✅ Session-Based authentication (via **flask_login**), Forms validation\n\n\u003cbr /\u003e\n\n![Material Kit - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/167396765-c88b7a95-155f-4236-8691-7b80fa2d9cd9.png)\n\n\u003cbr /\u003e\n\n## ✨ How to use it\n\n\u003e Download the code \n\n```bash\n$ git clone https://github.com/app-generator/sample-flask-mongo.git\n$ cd sample-flask-mongo\n```\n\n\u003cbr /\u003e\n\n### 👉 Set Up for `Unix`, `MacOS` \n\n\u003e Install modules via `VENV`  \n\n```bash\n$ virtualenv env\n$ source env/bin/activate\n$ pip3 install -r requirements.txt\n```\n\n\u003cbr /\u003e\n\n\u003e Set Up Flask Environment\n\n```bash\n$ export FLASK_APP=run.py\n$ export FLASK_ENV=development\n```\n\n\u003cbr /\u003e\n\n\u003e Start the app\n\n```bash\n$ flask run\n```\n\nAt this point, the app runs at `http://127.0.0.1:5000/`. \n\n\u003cbr /\u003e\n\n### 👉 Set Up for `Windows` \n\n\u003e Install modules via `VENV` (windows) \n\n```\n$ virtualenv env\n$ .\\env\\Scripts\\activate\n$ pip3 install -r requirements.txt\n```\n\n\u003cbr /\u003e\n\n\u003e Set Up Flask Environment\n\n```bash\n$ # CMD \n$ set FLASK_APP=run.py\n$ set FLASK_ENV=development\n$\n$ # Powershell\n$ $env:FLASK_APP = \".\\run.py\"\n$ $env:FLASK_ENV = \"development\"\n```\n\n\u003cbr /\u003e\n\n\u003e Start the app\n\n```bash\n$ flask run\n```\n\nAt this point, the app runs at `http://127.0.0.1:5000/`. \n\n\u003cbr /\u003e\n\n### 👉 Create Users\n\nBy default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up: \n\n- Start the app via `flask run`\n- Access the `registration` page and create a new user:\n  - `http://127.0.0.1:5000/register`\n- Access the `sign in` page and authenticate\n  - `http://127.0.0.1:5000/login`\n\n\u003cbr /\u003e\n\n## ✨ Code-base structure\n\nThe project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:\n\n```bash\n\u003c PROJECT ROOT \u003e\n   |\n   |-- apps/\n   |    |\n   |    |-- home/                           # A simple app that serve HTML files\n   |    |    |-- routes.py                  # Define app routes\n   |    |\n   |    |-- authentication/                 # Handles auth routes (login and register)\n   |    |    |-- routes.py                  # Define authentication routes  \n   |    |    |-- models.py                  # Defines models  \n   |    |    |-- forms.py                   # Define auth forms (login and register) \n   |    |\n   |    |-- static/\n   |    |    |-- \u003ccss, JS, images\u003e          # CSS files, Javascripts files\n   |    |\n   |    |-- templates/                      # Templates used to render pages\n   |    |    |-- includes/                  # HTML chunks and components\n   |    |    |    |-- navigation.html       # Top menu component\n   |    |    |    |-- sidebar.html          # Sidebar component\n   |    |    |    |-- footer.html           # App Footer\n   |    |    |    |-- scripts.html          # Scripts common to all pages\n   |    |    |\n   |    |    |-- layouts/                   # Master pages\n   |    |    |    |-- base-fullscreen.html  # Used by Authentication pages\n   |    |    |    |-- base.html             # Used by common pages\n   |    |    |\n   |    |    |-- accounts/                  # Authentication pages\n   |    |    |    |-- login.html            # Login page\n   |    |    |    |-- register.html         # Register page\n   |    |    |\n   |    |    |-- home/                      # UI Kit Pages\n   |    |         |-- index.html            # Index page\n   |    |         |-- 404-page.html         # 404 page\n   |    |         |-- *.html                # All other pages\n   |    |    \n   |  config.py                             # Set up the app\n   |    __init__.py                         # Initialize the app\n   |\n   |-- requirements.txt                     # App Dependencies\n   |\n   |-- .env                                 # Inject Configuration via Environment\n   |-- run.py                               # Start the app - WSGI gateway\n   |\n   |-- ************************************************************************\n```\n\n\u003cbr /\u003e\n\n---\n[Flask \u0026 Mongo](https://github.com/app-generator/sample-flask-mongo) `sample` - Open-source starter generated by **[App Generator](https://appseed.us/generator/)**.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fsample-flask-mongo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapp-generator%2Fsample-flask-mongo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fsample-flask-mongo/lists"}