Glimpse API server

This is the Glimpse API server.

Compilation and deployment

Host

Install needed libraries:

nimble install jester norm checksums

Build glimpse executable:

nimble build

Compile and run:

nimble run

Run unit tests:

nimble test

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 bin.dockerfile .

To deploy an instance of glimpse within docker, run:

docker buildx build -t glimpse-server:latest .
docker run -it --rm -p 8080:8080 glimpse-server:latest

Use the following to run a temporary PostgreSQL database, (DO NOT USE IN PRODUCTION):

docker run -it --rm -e POSTGRES_USER=user -e POSTGRES_PASSWORD=postgresql -p 5432:5432 postgres

Usage

Configuration

Glimpse will create the default configuration file, config.ini, in the root of the directory if it does not exist. Configuration relating to web framework, Jester, is under the Server section. Database configuration is under the Database section. Other configuration variables are under General.

API Endpoints

Each endpoint has comments describing what type of request it is and what parameters it takes. Example requests using cURL, more examples can be found in /tests/:

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