Skip to content

Commit

Permalink
Improve readme and docker-compose file
Browse files Browse the repository at this point in the history
  • Loading branch information
j-chmielewski committed Jul 21, 2023
1 parent 36551e3 commit 6c9def0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

Avanguard is a microservice performing OIDC-like registration/sign-in with a web3 wallet.

The repository contains 3 microservices:
The repository contains Avanguard microservice and 2 example projects:

- **avanguard**: provides REST API allowing web3 message signing, validation and OIDC id token retrieval
- **web**: frontend application connecting the wallet, performing message signing and communicating with Avanguard and backend apis
- **backend**: emulates client backend application, validates the token with HMAC algorithm
- **web**: example frontend application connecting the wallet, performing message signing and communicating with Avanguard and backend apis
- **backend**: example backend application, validates the token with HMAC algorithm

## How does it work?

Expand Down
2 changes: 2 additions & 0 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ services:
AG_DB_USER: avanguard
AG_DB_PASSWORD: avanguard
AG_DB_NAME: avanguard
AG_LOG_LEVEL: debug
AG_CLIENT_ORIGIN_URL: http://localhost:8000

db:
image: postgres:15.1-alpine3.17
Expand Down

0 comments on commit 6c9def0

Please sign in to comment.