Developers Italia API

Developers Italia API is the RESTful API of the Free and Open Source software catalog aimed at Italian Public Administrations.

Requirements

The application uses Air for live-reloading in the development environment.

To start developing:

Docker Compose will bring up the app and PostgreSQL containers.

Wait until the Docker logs explicitly say the API is up and you can use its endpoints at http://localhost:3000/v1/.

The application will automatically reload when a change is made.

You can configure the API with environment variables:

DATABASE_DSN: the URI used to connect to the database, fe postgres://user:password@host:5432/dbname. Supports PostgreSQL and SQLite.
PASETO_KEY (optional): Base64 encoded 32 bytes key used to check the PASETO authentication tokens. You can generate it with
```
head -c 32 /dev/urandom | base64
```
If not set, the API will run in read only mode.
ENVIRONMENT (optional): possible values test, development, production. Default production.
MAX_REQUESTS (optional): number of requests per minute after which responses will be ratelimited. Default: no limit.

This project exists also thanks to your contributions! Here is a list of people who already contributed to this repository:

The source code is released under the AGPL version 3.