Pet Projects API

An API to aggregate personal projects.

Features

• CRUD operations
• Authentication with JWT
• Layered Architecture
• Custom exceptions and handlers
• Database migrations with Alembic
• Management commands with Typer
• Dockenized app running PostgreSQL and pgAdmin
• Tests with Pytest
• Continuous Integration with Github Actions
• Continuous Deployment at Heroku

Live Preview

See the live preview deployed at Heroku.

Getting Started

Prerequisites

• Git
• Docker
• Docker-compose
• Python 3.10.1
• Poetry

Setup

1. Clone this repository:

git clone [email protected]:diogo-alves/pet-projects-api.git

2. Go to the project directory:

cd pet-projects-api

3. Install the project dependencies:

make install

4. Create an .env¹ file based on .env.example . To generate the SECRET_KEY run:

make secret-key

¹ NOTE: By running the app locally, you can set DATABASE_URL to use SQLite without having to install a database system.

Running

Locally

make local

With Docker

make docker

Tests

make tests

View in Browser

• API: http://localhost:8000/api/docs
• pgAdmin: http://localhost:5050 (only running with docker)

Management Commands

To see all commands type:

make commands

API Documentation

• Swagger UI: (http://localhost:8000/api/docs/
• Redoc: http://localhost:8000/api/redoc

License

This project is under the terms of the MIT license.