The following guide will describe how to get the Fidescls API going, step-by-step.
Docker and Docker-Compose are the only requirements here.
dockerlocally (see Docker Desktop or your preferred installation). The minimum verified Docker version is
- If your
dockerinstallation did not include
docker-compose, make sure to get at least version
1.29.0. Installation instructions can be found here.
Makeis an additional requirement should you wish to run the container without having to create a
If taking advantage of the
Makefile, the following commands can be used from the root
make cli: In addition to spinning up the API, this will drop you into a shell within the container. This can be used to explore, debug, etc. within the container.
make api: This will spin up the API and display the logs to the terminal.
Manual Docker Setup
This is a reference file that you can copy/paste into a local
docker-compose.yml file. It will create spin up the Fidescls API server. Make sure that you don't have anything else running on port
8765 before using this file.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
Now we can start interacting with our installation. You can run the following commands to get going:
docker-compose up -d-> This will spin up the docker-compose file in the background
docker-compose run --rm fidescls /bin/bash-> Opens a shell within the fidescls container
To ensure that the API is running and healthy, the following GET request can be sent to the
Now that you've got the API server up and running, you are ready to start making requests! Check out the Requests page for some guidance and examples.