Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rarimo/humanornot-svc
humanornot-svc as a part of identity protocol is used to trigger credentials issuance on issuer service after successful verification
https://github.com/rarimo/humanornot-svc
did poh proof-of-humanity
Last synced: about 1 month ago
JSON representation
humanornot-svc as a part of identity protocol is used to trigger credentials issuance on issuer service after successful verification
- Host: GitHub
- URL: https://github.com/rarimo/humanornot-svc
- Owner: rarimo
- License: mit
- Created: 2023-10-27T10:37:03.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-11T11:11:53.000Z (9 months ago)
- Last Synced: 2024-06-19T15:08:45.940Z (6 months ago)
- Topics: did, poh, proof-of-humanity
- Language: Go
- Homepage: https://robotornot.rarimo.com/
- Size: 9.3 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# humanornot-svc
## Description
The service has a partial integration with several identity providers. It provides an ability to check user's uniqueness
and if so then issue a corresponding [Iden3](https://docs.iden3.io/) Verifiable Credentials via an interface to the [Issuer
service](github.com/rarimo/issuer)
Integrated identity provider:
- [Unstoppable domains](https://unstoppabledomains.com/blog/categories/web3-domains/article/introducing-login-with-unstoppable)
- [Civic](https://www.civic.com/)
- [WorldCoin](https://docs.worldcoin.org/)
- [GitCoin Passport](https://docs.passport.gitcoin.co/overview/introducing-gitcoin-passport)
## Install
```
git clone github.com/rarimo/humanornot-svc
cd humanornot-svc
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/humanornot-svc .
docker run -e KV_VIPER_FILE=/config.yaml github.com/rarimo/humanornot-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/).