https://github.com/teddyoweh/fastapiboilerplate
FAST API boilerplate
https://github.com/teddyoweh/fastapiboilerplate
Last synced: 2 months ago
JSON representation
FAST API boilerplate
- Host: GitHub
- URL: https://github.com/teddyoweh/fastapiboilerplate
- Owner: teddyoweh
- License: mit
- Created: 2022-06-14T10:11:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-14T10:49:16.000Z (over 3 years ago)
- Last Synced: 2025-03-24T00:26:50.694Z (6 months ago)
- Language: Python
- Size: 29.3 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FastAPI Boilerplate
A template to start on FastAPI backend projects.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
You'll need `python@3.8`, `pipenv` and `postgresql@12` installed on your system to run the project.
### Installing
Run the following command to install all the project dependencies.
```shell script
pipenv install
```
Make sure your local PostgreSQL server is running on `http://localhost:5432`. Then, create a new database called `fastapi_db`.
```shell script
psql postgres
postgres=# create database fastapi_db;
```
**Note:** If you have a different database URL, set it in the `.env` environment file.
Now, run the `prestart.sh` script that'll create the tables and add initial data.
```shell script
./prestart.sh
```
If there are any changes to the `SQLALCHEMY_DATABASE_URI` key in the `.env` file, please run the `prestart.sh` script again.
### Running
After all the above mentioned steps, you can start the application using the following command:
```shell script
python -m app.main
```
The application will be available at https://localhost:8000.
## Development
These instructions will provide you some useful information on developing this application.
### Migrations
If there are any changes to the SQLAlchemy ORM models, you can run the following command to generate `alembic` migrations.
```shell script
alembic revision --autogenerate -m ""
```
This command will generate a new migration file in the `migrations` directory. Remember to check the generated migration file before committing.
## Testing
The application unit tests are inside the `app/tests` module.
Run the following command in the terminal to execute the application unit tests.
```shell script
pytest app/tests
```
## Deployment
The application can be deployed in production using `gunicorn`, you don't need to make any code changes for the same.
Head over to the [Uvicorn Deployment](https://www.uvicorn.org/deployment/) documentation for complete instructions.
## Built With
* [FastAPI](https://fastapi.tiangolo.com/) - The API framework used
* [SQLAlchemy](https://www.sqlalchemy.org/) - Database ORM
* [Pipenv](https://pypi.org/project/pipenv/) - Dependency and virtual environment manager
## Authors
* **Surya Kant Bansal** - *Initial work* - [skb1129](https://github.com/skb1129)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details