Skip to content

isabella232/uportlandia

 
 

Repository files navigation

uPortlandia

uPortlandia is our vision of the future of data and identity management. We hope that the examples contained within this repository will serve as a guide for your adoption of sovereign identity solution(s).

uportlandia

What's inside:

  • Serverless artifacts created:
    • KMS key for SSM
    • S3 Bucket for static site deployment
    • API gateway lambda function to securely sign claims
  • Setup task:
    • Creates Issuer (application) Identities
    • Stores the generated Identity key/pairs in SSM

Requirements

  • NodeJS 10+
  • Yarn ( curl -o- -L https://yarnpkg.com/install.sh | bash )
  • Serverless Framework (npm install serverless -g)
  • AWS (managed by serverless)

Initial Setup

Step 1

Change setup_config.js to suit your requirements

Step 2

Save your AWS credentials in ~/.aws/credentials under the [default] profile.

Step 3

yarn setup --env stage

The setup script

  • registers Issuer Entities
  • saves private keys and DIDs to SSM parameter store
  • deploys the signer lambdas
  • builds the static bundle and uploads to an S3 bucket

Step 4:

Repeat the process for --env prod.

Running Locally

Lambdas

Start Serverless Offline:

yarn local:api

Front End

In a separate terminal window, run

yarn start

Open http://localhost:3000/

Deploying Changes

Lambdas

yarn deploy:api --env stage

Front End

yarn deploy:static  --env stage

Note: --env must be stage or prod.

Whitelabel Config

  1. Change the Whitelabel Config
  2. Customize the Static Text: English and Spanish
  3. Change the Color Palette

FAQ and helpdesk support

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 97.9%
  • HTML 1.4%
  • CSS 0.7%