Toudou is an ultra-simple, ultra-light and ultra-insecure to-do list API. This must only serve for experimentation and dev purposes.
v0.1.2
This repo consists of a compose file with 4 containers :
- pgsql, a PostgreSQL database.
- on-startup-migration, a container that run sqitch migrations on startup.
- postgrest, that autogenerate a REST API automatically from the db with PostgREST.
- swagger-ui, serves the API documentation in a swagger UI frontend.
# Duplicate env file and adapt env var to fit your needs
cp .env.example .env
# Start the containers
docker compose up -d
- The database is available on port
5432
. - The API is available on port
3000
. - The swagger is available on port
8080
.
You can easily create new migrations with sqitch to extend the database. Feel free to create roles and grants to allow more advanced user authentication scenarios, see The Golden Key.