api.tamdaz.fr

A portfolio API made with Crystal Programming Language & Athena Framework.

This project is open-source so that you can use the source files as inspiration for your own projects.

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

Shards

Recommended Crystal version: 1.19.x

Guide

For this project, using go-task (alias task) is recommended, it enables to automate scripts when setting up the configuration, database, file system, unit tests and so on.

To install the shards:

task install

Then, configure the .env configuration file and setup the migration:

task setup

Also, you need to link 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(s)

• tamdaz (Creator & Maintainer)