skgbafa/ssx

Self-Sovereign Anything

SSX

SSX is a library that enables you to easily add user authentication, session management, and more to your dapp.

Documentation

https://docs.ssx.id

SDKs

• Client side under ./packages/ssx-sdk.
• Server side under ./packages/ssx-server.

Useful Commands

• npm run build - Build all packages
• npm run examples - Concurrently run the example server and app found in ./examples
• npm run clean - Remove all build artifacts and node_modules

Docker

SSX ships with a Docker Compose configuration for setting up a local development and testing environment with SSX server and our example dapp. Make sure you have Docker and Compose installed, then create a .env file in the project root:

ssx_listenPort=8443 # ssx server will be available on http://localhost:8443
ssx_signingKey= # session secret for ssx server
ssx_providers__metrics__apiKey= # ssx metrics api key https://app.ssx.id
ssx_providers__rpc__apiKey= # infura api key for wallet connect (optional)

Save your .env file and from the project root, run:

docker compose up

Docker will build containers for the SSX server and example dapp from the working tree and start them both.

• Example dapp: http://localhost:3000
• SSX Server: http://localhost:8443