fastapi-boilerplate - GitLite

KO | EN

gitlite — search

#python #ai #llm #go #golang #linux #macos #nodejs #windows #cli #vue #awesome-list #security #openai

fastapi-boilerplate

(★ 134)

A template repository to start your FastAPI backend projects.

File Explorer

Download Latest Version (.zip)

- - __init__.py
  - deps.py
- - __init__.py
  - config.py
- - __init__.py
  - base.py
  - product.py
- - __init__.py
  - base.py
  - base_class.py
  - initialise.py
  - session.py
- - __init__.py
  - product.py
- - __init__.py
  - message.py
  - product.py
- - __init__.py
  - conftest.py
- __init__.py
- initialiser.py
- main.py
- - .gitkeep
  - eaae517c1e2f_initialise.py
- env.py
- README
- script.py.mako
.env
.gitignore
alembic.ini
LICENSE
Pipfile
Pipfile.lock
prestart.sh
README.md

# Installation Guide

1. Get the code

git clone https://github.com/skb1129/fastapi-boilerplate

Downloads the entire project code from GitHub to your computer.

cd fastapi-boilerplate

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pipenv install

Type this command into your terminal and run it.

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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 "<migration message>"
```
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