{"id":16175443,"url":"https://github.com/app-generator/boilerplate-code-flask","last_synced_at":"2025-04-07T11:16:20.590Z","repository":{"id":179596583,"uuid":"660891538","full_name":"app-generator/boilerplate-code-flask","owner":"app-generator","description":"Boilerplate Code - Flask Template project | AppSeed","archived":false,"fork":false,"pushed_at":"2023-07-01T06:26:34.000Z","size":6538,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-06T18:12:46.477Z","etag":null,"topics":["flask-apps","flask-boilerplate","flask-starter","flask-template"],"latest_commit_sha":null,"homepage":"https://appseed.us/apps/flask/","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-01T06:11:47.000Z","updated_at":"2024-07-28T21:10:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"0a87400c-339e-4b52-89b5-c26ca9a4c556","html_url":"https://github.com/app-generator/boilerplate-code-flask","commit_stats":null,"previous_names":["app-generator/boilerplate-code-flask"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fboilerplate-code-flask","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fboilerplate-code-flask/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fboilerplate-code-flask/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fboilerplate-code-flask/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/app-generator","download_url":"https://codeload.github.com/app-generator/boilerplate-code-flask/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247640468,"owners_count":20971558,"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-apps","flask-boilerplate","flask-starter","flask-template"],"created_at":"2024-10-10T04:44:51.759Z","updated_at":"2025-04-07T11:16:20.584Z","avatar_url":"https://github.com/app-generator.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Flask Boilerplate](https://appseed.us/boilerplate-code/flask-boilerplate/)\n\nReference codebase used by `AppSeed` in all Flask [Apps](https://appseed.us/apps/flask/) and [Dashboard](https://appseed.us/admin-dashboards/flask/) starters - the product uses an amazing design crafted by `Creative-Tim`.\n\n- 👉 [Flask Boilerplate](https://appseed.us/boilerplate-code/flask-boilerplate/) - `Product page`\n- 👉 [Flask Boilerplate](https://flask-material-kit.appseed-srv1.com/) - `LIVE App`\n- 👉 Free [Support](https://appseed.us/support/) via `Email` \u0026 `Discord`\n\n\u003cbr /\u003e\n\n\u003e 🚀 Built with [App Generator](https://appseed.us/generator/), Timestamp: `2022-06-08 12:24`\n\n- ✅ `Up-to-date dependencies`\n- ✅ `Database`: `SQLite`, MySql\n  - Silent fallback to `SQLite`\n- ✅ `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)\n- ✅ Session-Based authentication (via **flask_login**), Forms validation\n- ✅ Docker, `Flask-Minify` (page compression)\n- 🚀 `Deployment` \n  - `CI/CD` flow via `Render`\n  - [Flask Material Kit - Go LIVE](https://www.youtube.com/watch?v=bSFw6xrd57w) (`video presentation`)  \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## Start with `Docker`\n\n\u003e 👉 **Step 1** - Download the code from the GH repository (using `GIT`) \n\n```bash\n$ git clone https://github.com/app-generator/boilerplate-code-flask.git\n$ cd boilerplate-code-flask\n```\n\n\u003cbr /\u003e\n\n\u003e 👉 **Step 2** - Start the APP in `Docker`\n\n```bash\n$ docker-compose up --build \n```\n\nVisit `http://localhost:5085` in your browser. The app should be up \u0026 running.\n\n\u003cbr /\u003e\n\n## Manual Build \n\n\u003e Download the code \n\n```bash\n$ git clone https://github.com/app-generator/boilerplate-code-flask.git\n$ cd boilerplate-code-flask\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## Codebase 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 Boilerplate](https://appseed.us/boilerplate-code/flask-boilerplate/) - 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%2Fboilerplate-code-flask","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapp-generator%2Fboilerplate-code-flask","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fboilerplate-code-flask/lists"}