{"id":16175221,"url":"https://github.com/app-generator/fastapi-soft-ui-dashboard","last_synced_at":"2025-07-05T05:05:51.745Z","repository":{"id":100502900,"uuid":"541957910","full_name":"app-generator/fastapi-soft-ui-dashboard","owner":"app-generator","description":"FastAPI Soft Dashboard - Open-Source Starter built on top of a modern Bootstrap Design | App-Generator.dev","archived":false,"fork":false,"pushed_at":"2025-05-06T06:06:25.000Z","size":26366,"stargazers_count":47,"open_issues_count":2,"forks_count":11,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-01T16:18:54.863Z","etag":null,"topics":["fastapi","fastapi-starter","fastapi-starter-kit","fastapi-starter-template","open-source"],"latest_commit_sha":null,"homepage":"https://app-generator.dev/docs/technologies/fastapi/index.html","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":"2022-09-27T07:28:54.000Z","updated_at":"2025-05-06T06:06:28.000Z","dependencies_parsed_at":null,"dependency_job_id":"f0ef9886-255a-4d33-aec9-14200c148f10","html_url":"https://github.com/app-generator/fastapi-soft-ui-dashboard","commit_stats":null,"previous_names":[],"tags_count":1,"template":true,"template_full_name":null,"purl":"pkg:github/app-generator/fastapi-soft-ui-dashboard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Ffastapi-soft-ui-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Ffastapi-soft-ui-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Ffastapi-soft-ui-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Ffastapi-soft-ui-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/app-generator","download_url":"https://codeload.github.com/app-generator/fastapi-soft-ui-dashboard/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Ffastapi-soft-ui-dashboard/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263687149,"owners_count":23496088,"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":["fastapi","fastapi-starter","fastapi-starter-kit","fastapi-starter-template","open-source"],"created_at":"2024-10-10T04:44:24.607Z","updated_at":"2025-07-05T05:05:51.740Z","avatar_url":"https://github.com/app-generator.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [FastAPI](https://app-generator.dev/docs/technologies/fastapi/index.html) Soft Dashboard\n\nOpen-source [FastAPI](https://app-generator.dev/docs/technologies/fastapi/index.html) built on top of a modern `Bootstrap 5` design. Designed for those who like bold elements and beautiful websites, **[Soft UI Dashboard](https://app-generator.dev/product/soft-ui-dashboard/)** is ready to help you create stunning websites and web apps. \n\n\u003e 👉 For more [FastAPI Resources](https://app-generator.dev/docs/technologies/fastapi.html) please access:\n\n- [Getting Started with FastAPI](https://app-generator.dev/docs/technologies/fastapi/index.html)\n- [FastAPI Cheatsheet](https://app-generator.dev/docs/technologies/fastapi/cheatsheet.html)\n\n\u003cbr /\u003e\n\n\u003e Product Roadmap \n\n| Status | Item | info | \n| --- | --- | --- |\n| ✅ | **Up-to-date Dependencies** | - |\n| ✅ | **[Soft Dashboard Design](https://app-generator.dev/product/soft-ui-dashboard/)** | Designed by **[Creative-Tim](https://app-generator.dev/agency/creative-tim/)** |\n| ✅ | **UI Kit** | `Bootstrap 5`, `Dark-Mode` (persistent) |\n| ✅ | **Persistence** | `SQLite`, `MySql` |\n| ✅ | **Basic Authentication** | classic user/password |\n| ✅ | **API** | Products \u0026 Sales (linked tables) |\n|     |         | GET Requests (public), `get/`, `get/id`  |\n|     |         | Mutating requests (Create, UPD, DEL) (reserved for authenticated users) |\n| ❌ | **Docker** | Simple Setup (local usage) |\n| ❌ | **OAuth** | `Github` \u0026 `Twitter` providers |\n| ❌ | Unitary tests | - |\n\n\u003cbr /\u003e\n\n![Soft UI Dashboard - Open-source FastAPI starter provided by by AppSeed.](https://user-images.githubusercontent.com/51070104/175773323-3345d618-0e78-4c85-83fc-f495dc3f0bb0.png)\n\n\u003cbr /\u003e\n\n## Project Structure\n\n\u003e This application is composed of `3 basic parts` in the root folder.\n\n- `src` provides the codebase for the main application.\n- `alembic` manages the DB database migration layer\n- `tests` stores the unit testing library.\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/fastapi-soft-ui-dashboard.git\n$ cd fastapi-soft-ui-dashboard\n```\n\n\u003cbr /\u003e\n\n\u003e Install modules via `VENV`\n\n```bash\n$ python -m venv env\n$ source env/bin/activate\n$ pip install -r requirements.txt\n```\n\n\u003cbr /\u003e\n\n\u003e Create `.env` from `env.sample` - here is a sample \n\n**Note:** Setting the `debugging` config to `1` will start the app with `SQLite`, setting it to `0` will start the app with `MySql`. \n\n```env\nDEBUGGING=1\n\nDATABASE_HOSTNAME=localhost\nDATABASE_PORT=5432\nDATABASE_PASSWORD=somepassword\nDATABASE_NAME=somedbname\nDATABASE_USERNAME=mayberoot\n\nSECRET_KEY=SUPER_SECRET_HERE\nALGORITHM=HS256\n\nACCESS_TOKEN_EXPIRE_MINUTES=30\n```\n\n\u003cbr /\u003e\n\n\u003e Migrate the database (`create tables`)\n\n```bash\n$ alembic upgrade head\n```\n\n\u003cbr /\u003e\n\n\u003e Start the app\n\n```bash\n$ uvicorn src.app:app --reload\n```\n\nAt this point, the app runs at `http://127.0.0.1:8000/`. \n\n\u003cbr /\u003e\n\n## ✨ Codebase structure\n\nThe project is coded using a modular, intuitive structure as presented below:\n\n```bash\n\u003c PROJECT ROOT \u003e\n   |\n   |-- src/\n   |    |\n   |    |-- helpers/                        # A simple app that serve HTML files\n   |    |    |-- database.py                # Define app routes\n   |    |    |-- utils.py                   # Define app routes\n   |    |\n   |    |-- routers/                        # Handles routes (all sections)\n   |    |    |-- auth/                      # Implements authentication routes  \n   |    |    |-- ui_routes.py                 \n   |    |    |-- user_routes.py\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   |  models.py                             # Defines the models\n   |  config.py                             # Holds APP Configuration\n   |  __init__.py                           # Builds the FastAPI object\n   |  app.py                                # Bundles ALL resources\n   |\n   |-- requirements.txt                     # App Dependencies\n   |\n   |-- .env                                 # Inject Configuration via Environment\n   |\n   |-- ************************************************************************\n```\n\n\u003cbr /\u003e \n\n---\n[FastAPI](https://app-generator.dev/docs/technologies/fastapi/index.html) Soft Dashboard - Open-source eCommerce Starter provided by [App-Generator](https://app-generator.dev/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Ffastapi-soft-ui-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapp-generator%2Ffastapi-soft-ui-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Ffastapi-soft-ui-dashboard/lists"}