Glimpse/server
1
0
Fork 0
mirror of https://github.com/glimpse-app/server.git synced 2025-04-02 10:52:45 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

updated

Browse source
This commit is contained in:
array-in-a-matrix 2024-07-24 14:41:33 -04:00
parent 7371cf73c2
commit 4a4e8c8b62
1 changed files with 20 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -2,7 +2,9 @@
This is the Glimpse API server. This is the Glimpse API server.
## Run test server instance ## Compilation and deployment
### Host
Install needed libraries: Install needed libraries:
@ -10,19 +12,19 @@ Install needed libraries:
nimble install jester norm checksums nimble install jester norm checksums
``` ```
Build glimpse executable:
```sh
nimble build
```
Compile and run: Compile and run:
```sh ```sh
nimble run nimble run
``` ```
Build project: ### Docker
```sh
nimble build
```
## Docker
To compile the binary only, run the following (executable will be found in `/bin/`): To compile the binary only, run the following (executable will be found in `/bin/`):
@ -30,20 +32,26 @@ 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 docker buildx build -t glimpse-server:latest --output=bin --target=runner -f
``` ```
To deploy an instance of the server within docker, run: To deploy an instance of glimpse within docker, run:
```sh ```sh
docker buildx build -t glimpse-server:latest . docker buildx build -t glimpse-server:latest .
docker run -it --rm -p 5000:5000 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**): Use the following to run a temporary PostgreSQL database, (**DO NOT USE IN PRODUCTION**):
```sh ```sh
docker run -it --rm -e POSTGRES_USER=user -e POSTGRES_PASSWORD=postgres -p 5432:5432 postgres docker run -it --rm -e POSTGRES_USER=user -e POSTGRES_PASSWORD=postgresql -p 5432:5432 postgres
``` ```
## API Endpoints ## 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](https://github.com/dom96/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. Each endpoint has comments describing what type of request it is and what parameters it takes.
Example requests using `cURL`: Example requests using `cURL`: