uservice-passkeys

README

Service: Passkeys

Passwords and secret keys manager.

Prerequisites

• Go
• Make
  • macOS:

    brew install make
    

  • Ubuntu:

    sudo apt-get install make
    

  • Windows: Install chocolatey (from a PowerShell with admin privileges), then run:

    choco install make
    

Install the project dependencies.

go get ./... && go mod tidy

Run the project locally

From command line

make run

From GitHub packages

You can get a working version of the service from the GitHub packages, using this image:

ghcr.io/a-novel/uservice-passkeys/master:latest

You can replace the master part with the name of any branch, to retrieve the image built from that branch. Or replace latest with the sha of a commit to get the image built from that commit.

The image needs 2 environment variables to work:

• PORT: The port the service will listen to.
• DSN: The connection string to a postgres database.

Make test queries

You can run queries on the go from a terminal using grpcurl. Below is an example for the global health check (available on all services).

grpcurl -plaintext -d '{"service": ""}' localhost:4003 grpc.health.v1.Health/Check

Work on the project

Make sure the project files are properly formatted.

make format

Run tests.

make test

Make sure your code is compliant with the linter.

make lint

If you create / update interfaces signatures, make sure to update the mocks.

make mocks