https://github.com/ari-hacks/fastapi-boilerplate
A Boilerplate FastApi project
https://github.com/ari-hacks/fastapi-boilerplate
boilerplate boilerplate-application boilerplate-fastapi docker fastapi fastapi-boilerplate fastapi-template pytest python python3 template travis-ci
Last synced: 6 months ago
JSON representation
A Boilerplate FastApi project
- Host: GitHub
- URL: https://github.com/ari-hacks/fastapi-boilerplate
- Owner: ari-hacks
- License: mit
- Created: 2020-05-07T09:35:51.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-14T22:15:11.000Z (about 3 years ago)
- Last Synced: 2025-07-04T07:07:13.166Z (8 months ago)
- Topics: boilerplate, boilerplate-application, boilerplate-fastapi, docker, fastapi, fastapi-boilerplate, fastapi-template, pytest, python, python3, template, travis-ci
- Language: Python
- Homepage:
- Size: 38.1 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FastApi Skeleton
A Boilerplate FastApi project
 [](https://travis-ci.com/ari-hacks/fastapi-skeleton)
## Features
- [x] Boilerplate project structure
- [x] Asynchronous API
- [ ] User login and Authentication
- [ ] MongoDb
- [ ] CRUD endpoints
- [x] Travis CI configuration before deploy
- [x] API testing with `pytest`
- [x] Pipenv dependency management
- [x] Docker containerization and deploy to Heroku
## Set up
### Requirements
- [Python](https://www.python.org/) 3.8.1
- Pipenv
## Running Locally
1. Clone this repository and `cd` into it
```bash
→ git clone https://github.com/ari-hacks/fastapi-skeleton.git
→ cd fastapi-skeleton
```
2. Pipenv dependency management
```bash
#run pipenv
→ pipenv shell
```
```bash
#install dependencies
→ pipenv install
#run locally
→ uvicorn app.main:app --reload
```
3. [Install & Run in docker](https://hub.docker.com/)
4. Build Docker Image
```bash
➜ docker build -t app .
```
5. Start Docker container
```bash
➜ docker run -d --name fastapi-skeleton-container -p 5000:5000 app
```
6. Run the application
```bash
Uvicorn running on http://0.0.0.0:5000/users/health-check
#or
http://localhost:5000/users/health-check
```
7. Check the logs
```bash
➜ docker container logs -f fastapi-skeleton-container
```
## Deploy pre-configured (Docker Deploy)
Please [Sign up](https://www.heroku.com/) before Deploying.
[](https://heroku.com/deploy)