server/README.md
2024-07-19 17:30:33 -04:00

936 B

Glimpse API server

This is the Glimpse API server.

Run test server instance

Install needed libraries:

nimble install jester norm checksums

Compile and run:

nimble run

Build project:

nimble build

Docker

To compile the binary only, run the following (executable will be found in /bin/):

docker buildx build -t glimpse-server:latest --output=bin --target=runner -f

To deploy an instance of the server, run:


API Endpoints

Each endpoint has comments describing what type of request it is and what parameters it takes. Example requests using cURL:

curl -X <POST|GET|PUT|DELETE> <Endpoint URI> -H '<Request Body Contents>'
curl -X POST http://localhost:5000/api/v1/newUser -H 'Username=Array' -H 'Password=i8Vl8XZaVRiZFsZ'
curl -X POST -H "Authorization: <access_token>" -F "file=@image.png" http://localhost:5000/api/v1/newFile