Start by pulling the image from docker hub

docker pull ghcr.io/applets/backend-hello:<VERSION>

multiple versions are available, you can check them here

The default one is latest but for cutting edge updates you can use main branch name.

ℹ️ If your database is already created and running, you can skip this step and directly go to Run the image.

Access this repository to get started!

You'll need to setup the environment variables in the .env file

Simply copy and paste the .env.template file, rename it to .env and fill it with the correct value.

Then, run the image on your local machine

docker run --env-file .env --restart always -d -p 8080:8080 -v <PATH_TO_VOLUME_FOLDER>:/app/volume:rw --name ps-api ghcr.io/applets/backend-hello:<VERSION>

You can navigate to https://localhost:8080/swagger to check if the API is running correctly!