fastapi-app

KO | EN

gitlite — search

#javascript #python #react #machine-learning #deep-learning #macos #java #nodejs #awesome #cli #kubernetes #awesome-list #security #mcp

(★ 70)

A FastAPI complete application with nice features and tests

fastapi-app Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Python FastAPI App

A FastAPI complete application with nice features and tests.

[![Test](https://github.com/paulocoutinhox/fastapi-app/actions/workflows/test.yml/badge.svg)](https://github.com/paulocoutinhox/fastapi-app/actions/workflows/test.yml)

[![codecov](https://codecov.io/gh/paulocoutinhox/fastapi-app/graph/badge.svg?token=SFNWCA8JQ4)](https://codecov.io/gh/paulocoutinhox/fastapi-app)

## What is included

- Senior organization support
- Database support
- Scheduler jobs support
- Test, mock and code coverage support
- Service layer support
- Pydantic support
- Rate limiter support
- CORS support
- Static files support
- Docker support (single and compose)
- Ready for production
- Support for Python version from 3.10 to 3.14

## Use Cases

APIs are essential for various types of applications, including:

- Mobile applications
- Progressive Web Applications (PWA)
- Single Page Applications (SPA)
- Microservices
- Internet of Things (IoT) applications
- Desktop applications that require online functionalities
- JAMstack websites and applications
- Low-Code and No-Code services like Bubble, FlutterFlow and others

## Start Locally

To start locally execute:

```bash
uvicorn main:app --host 0.0.0.0 --port 8000 --log-level debug --reload
```

```bash
make start
```

## Docker Single

To build and start docker in single mode:

```bash
docker build -f Dockerfile.web -t fastapi-app .
docker run --rm -v ./:/app -p 8000:8000 fastapi-app
```

```bash
make docker-single-build
make docker-single-start
```

To use a different database url when run:

```bash
docker run --rm -v ./:/app -p 8000:8000 -e DATABASE_URL="sqlite+aiosqlite:///./other.db" fastapi-app
```

## Docker Compose

To build and start docker compose with application and database:

```bash
docker compose build
docker compose up -d
```

```bash
make docker-compose-build
make docker-compose-start
```

To stop docker compose:

```bash
docker compose down
```

```bash
make docker-compose-stop
```

## Tests

To run tests execute:

```bash
python3 -m pytest
```

```bash
make test
```

To run tests execute with code coverage:

```bash
python3 -m pytest --cov=. --maxfail=1 tests/
```

```bash
make test-cov
```

## API Tester

Once the API server is running, you can test your APIs by accessing the following URL:

```
http://localhost:8000/docs
```

## Database

The project includes a sample database model with the following structure:

```sql
CREATE TABLE my_model (
    id SERIAL PRIMARY KEY,
    field1 VARCHAR(255) NOT NULL,
    field2 BOOLEAN NOT NULL DEFAULT FALSE,
    created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
    updated_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
);
```

This model demonstrates:
- Auto-incrementing primary key (`id`)
- String field with maximum length of 255 characters (`field1`)
- Boolean field with default value (`field2`)
- Automatic timestamp for record creation (`created_at`)
- Automatic timestamp for record updates (`updated_at`)

The database is configured to use SQLite by default, but you can easily switch to other databases by modifying the `DATABASE_URL` environment variable.

## License

[MIT](http://opensource.org/licenses/MIT)

fastapi-app

fastapi-app Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

fastapi-app

fastapi-app Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README