https://github.com/rarimo/verificator-svc
https://github.com/rarimo/verificator-svc
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/rarimo/verificator-svc
- Owner: rarimo
- Created: 2024-08-15T12:48:29.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T08:10:53.000Z (almost 2 years ago)
- Last Synced: 2024-10-24T08:12:25.530Z (almost 2 years ago)
- Language: Go
- Size: 10.1 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# verificator-svc
## Description
The service allows to verify [query proofs](https://github.com/rarimo/passport-zk-circuits/?tab=readme-ov-file#query-circuit).
The private endpoints must be available only inside your backend system.
Light verification is deprecated.
See also [integration doc](https://rarimo.notion.site/Requesting-ZK-Passport-proofs-dc43d1102e104d008e0d1c7db5326286)
## Install
```
git clone github.com/rarimo/verificator-svc
cd verificator-svc
go build main.go
export KV_VIPER_FILE=./config.yaml
./main migrate up
./main run service
```
## Configuration
You must specify following parameters before run the service:
- event_id - random decimal (up to 31 byte)
- callback_url - domain of your instance of the service
- allowed_identity_timestamp - date of your first production launch
## Documentation
We do use openapi:json standard for API. We use swagger for documenting our API.
To open online documentation, go to [swagger editor](http://localhost:8080/swagger-editor/) here is how you can start it
```
cd docs
npm install
npm start
```
To build documentation use `npm run build` command,
that will create open-api documentation in `web_deploy` folder.
To generate resources for Go models run `./generate.sh` script in root folder.
use `./generate.sh --help` to see all available options.
Note: if you are using Gitlab for building project `docs/spec/paths` folder must not be
empty, otherwise only `Build and Publish` job will be passed.
## Running from docker
Make sure that docker installed.
use `docker run ` with `-p 8080:80` to expose port 80 to 8080
```
docker build -t github.com/rarimo/verificator-svc .
docker run -e KV_VIPER_FILE=/config.yaml github.com/rarimo/verificator-svc
```
## Running from Source
* Set up environment value with config file path `KV_VIPER_FILE=./config.yaml`
* Provide valid config file
* Launch the service with `migrate up` command to create database schema
* Launch the service with `run service` command
### Database
For services, we do use ***PostgresSQL*** database.
You can [install it locally](https://www.postgresql.org/download/) or use [docker image](https://hub.docker.com/_/postgres/).
### Third-party services
## Contact
Responsible
The primary contact for this project is [//]: # (TODO: place link to your telegram and email)