api.tamdaz.fr

A portfolio API made with Crystal programming language & Athena Framework.

Try the API

If you want to test the portfolio API, you can download the Docker image with the specified version.

docker pull codeberg.org/tamdaz/api.tamdaz.fr

Once that image is pulled, you have to configure the .env file. Then, you can run the API by executing the command below.

docker run --rm --network="my_db_network" -p 3000:80 -it api.tamdaz.fr

[!IMPORTANT] It would be interesting to add the micrate binary into the api.tamdaz.fr's image. This enables to migrate the database easily. A new PR will be created for this todo.

Shards

Recommended Crystal version: 1.16.0

Guide

[!NOTE] The task command is required to automate the tasks.

To install the shards, run the command below:

task install

Then, configure the environment configuration and setup the migration by using the task:

task setup

Also, you need to link the uploaded files into the public/ directory thanks to:

task uploads:link

To run the API in the development mode, run:

task dev
# or
shards run api

Contributor

• tamdaz (Creator & Maintainer)