https://github.com/str00bs/template-api
FastAPI WebApp & API Template
https://github.com/str00bs/template-api
api docker docker-compose fastapi python template
Last synced: 2 months ago
JSON representation
FastAPI WebApp & API Template
- Host: GitHub
- URL: https://github.com/str00bs/template-api
- Owner: str00bs
- Created: 2025-01-23T17:02:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-23T17:06:05.000Z (over 1 year ago)
- Last Synced: 2025-03-19T08:49:34.223Z (over 1 year ago)
- Topics: api, docker, docker-compose, fastapi, python, template
- Language: Python
- Homepage:
- Size: 59.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FastAPI Application Template
A template API providing all the essential scaffolding required to smoothly develop a containerized FastAPI application.
## Setup
Run:
1. Copy ENV: `cp dist.env .env`
2. Run docker: `docker-compose up -d`
3. Open `0.0.0.0:80` in a web-browser
## Default Endpoints
The following default endpoints are provided by FastAPI and exposed by the template
- Front-End: `/`
- Swagger UI: `/docs`
- ReDoc Documentation: `/redoc`
- OpenAPI 3.0: `/openapi.json`
## Resources
Resources provided for the repository and application.
### General
General resources already provided for/with the application & repository.
- IDE Configurations: [VSCode](resources/vscode)
- Debugging & Testing:
- [Static Analysis Requirements](resources/requirements/analysis.txt)
- [Unit Testing Requirements](resources/requirements/testing.txt)
- [Security Scanning Requirements](resources/requirements/security.txt)
- Deployment Tools:
- Dockerfile: [Dockerfile](Dockerfile)
### SDK Docs
- API Framework: [FastAPI](https://fastapi.tiangolo.com/)
- Parent: [Starlette](https://www.starlette.io/)
- Auth: [FastAPI Azure Auth](https://github.com/Intility/fastapi-azure-auth)
- Schema: [Pydantic](https://pydantic-docs.helpmanual.io/)
- Testing:
- Runner: [Pytest](https://docs.pytest.org/en/6.2.x/)
- Async: [aiounittest](https://pypi.org/project/aiounittest/)
- Database
- ORM: [Masonite ORM](https://orm.masoniteproject.com/)
- _Formerly known as/continuation of: [Orator](https://orator-orm.com/)_
- Validation & Settings
- [Pydantic Settings](https://pydantic-docs.helpmanual.io/usage/settings/)