https://github.com/rarimo/verify-proxy
https://github.com/rarimo/verify-proxy
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rarimo/verify-proxy
- Owner: rarimo
- License: mit
- Created: 2023-11-13T14:46:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-22T14:54:04.000Z (almost 2 years ago)
- Last Synced: 2025-04-09T18:11:05.682Z (over 1 year ago)
- Language: Go
- Size: 134 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# verify-proxy
## Description
The service is designed to receive callbacks from PolygonID Wallet application. The callback contains a ZKP that satisfies some user's request. The front-end applicatiin can easily retrieve the user's proof by proof id.
## Install
```
git clone github.com/rarimo/verify-proxy
cd verify-proxy
go build main.go
export KV_VIPER_FILE=./config.yaml
./main migrate up
./main run service
```
## 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.
## 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/verify-proxy .
docker run -e KV_VIPER_FILE=/config.yaml github.com/rarimo/verify-proxy
```
## 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/).