{"id":19835177,"url":"https://github.com/equinor/template-fastapi-react","last_synced_at":"2025-04-06T13:09:23.354Z","repository":{"id":38372918,"uuid":"499866051","full_name":"equinor/template-fastapi-react","owner":"equinor","description":"A solution template for creating a Single Page App (SPA) with React and FastAPI following the principles of Clean Architecture.","archived":false,"fork":false,"pushed_at":"2025-03-01T03:00:13.000Z","size":212782,"stargazers_count":76,"open_issues_count":21,"forks_count":13,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-30T12:06:48.974Z","etag":null,"topics":["boilerplate","clean-architecture","cleanarchitecture","fastapi","python","react"],"latest_commit_sha":null,"homepage":"https://equinor.github.io/template-fastapi-react","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/equinor.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-04T15:33:49.000Z","updated_at":"2025-03-20T07:06:32.000Z","dependencies_parsed_at":"2023-02-19T06:00:54.522Z","dependency_job_id":"8f0e9c5e-4d0d-4030-9005-c36803da210c","html_url":"https://github.com/equinor/template-fastapi-react","commit_stats":{"total_commits":387,"total_committers":17,"mean_commits":"22.764705882352942","dds":0.7648578811369509,"last_synced_commit":"0caf81ed3deb44651d93619070887a5e606602ac"},"previous_names":[],"tags_count":8,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equinor%2Ftemplate-fastapi-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equinor%2Ftemplate-fastapi-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equinor%2Ftemplate-fastapi-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equinor%2Ftemplate-fastapi-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/equinor","download_url":"https://codeload.github.com/equinor/template-fastapi-react/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247485287,"owners_count":20946398,"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":["boilerplate","clean-architecture","cleanarchitecture","fastapi","python","react"],"created_at":"2024-11-12T12:06:58.828Z","updated_at":"2025-04-06T13:09:23.336Z","avatar_url":"https://github.com/equinor.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\r\n\r\n# Template Fastapi React\r\n\r\n[![License][license-badge]][license]\r\n[![On push main branch][on-push-main-branch-badge]][on-push-main-branch-action]\r\n\r\nThis is a **solution template** for creating a Single Page App (SPA) with React and FastAPI following the principles of Clean Architecture.\r\n\r\n[Key Features](#key-features) • [Quickstart](#quickstart) • [Development](#development) • [Contributing](#contributing)\r\n\r\n\u003c!--- The demo project is not currently deployed.\r\nA demo is running at https://template-fastapi-react.app.playground.radix.equinor.com\r\n--\u003e\r\n\r\n\u003c/div\u003e\r\n\r\n\r\n\u003ca id=\"key-features\"\u003e\u003c/a\u003e\r\n## :dart: Key features\r\n\r\n- Clean architecture\r\n- Screaming architecture\r\n- Auto-generated changelogs\r\n- Auto-generated OpenAPI specification\r\n- Automatic documentation of REST API\r\n- Auto-generated REST API clients\r\n- Pre-commit hooks\r\n- Pydantic data validation\r\n\r\n\u003ca id=\"quickstart\"\u003e\u003c/a\u003e\r\n## :zap: Quickstart\r\n\r\n### Prerequisites\r\n\r\nTo run the template todo-list application ([Running](#running)):\r\n- [Docker](https://www.docker.com/)\r\n\r\nFor development ([Development](#development)):\r\n- [Docker](https://www.docker.com/)\r\n- [Python 3.12](https://www.python.org/downloads/) or newer\r\n\r\n### Configuration\r\n\r\nEnvironment variables is used for configuration and must be set before running.\r\n\r\nCreate a copy of `.env-template` called `.env` and populate it with values:\r\n\r\n- `XYZ`: Specifies the [RESOURCE NAME] connection string\r\n\r\n**Note:** The template doesn't have any values that you need to replace, but any instantiated project probably will.\r\n\r\n### Running\r\n\r\nOnce you have done the configuration, you can start running:\r\n\r\n```sh\r\ndocker compose up --build\r\n```\r\n\r\nThe application will be served at http://localhost\r\n\r\nThe API documentation can be found at http://localhost:5000/docs\r\n\r\n\u003ca id=\"development\"\u003e\u003c/a\u003e\r\n## :dizzy: Development\r\n\r\nSee the [docs](https://equinor.github.io/template-fastapi-react/) if you want to start developing.\r\n\r\n\u003ca id=\"contributing\"\u003e\u003c/a\u003e\r\n## :+1: Contributing\r\n\r\nThanks for your interest in contributing! There are many ways to contribute to this project. Get started [here](CONTRIBUTING.md).\r\n\r\n[license-badge]: https://img.shields.io/badge/License-MIT-yellow.svg\r\n[license]: https://github.com/equinor/boilerplate-clean-architecture/blob/main/LICENSE\r\n[releases]: https://github.com/equinor/boilerplate-clean-architecture/releases\r\n[on-push-main-branch-badge]: https://github.com/equinor/boilerplate-clean-architecture/actions/workflows/on-push-main-branch.yaml/badge.svg\r\n[on-push-main-branch-action]: https://github.com/equinor/boilerplate-clean-architecture/actions/workflows/on-push-main-branch.yaml\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fequinor%2Ftemplate-fastapi-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fequinor%2Ftemplate-fastapi-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fequinor%2Ftemplate-fastapi-react/lists"}