SelfID

Monorepo for the SelfID SDK and reference application.

Installation

This monorepo uses Yarn workspaces, make sure to install it first if you don't already have it.

1. yarn install to install the dependencies
2. yarn build to build all the packages

Additional scripts

• yarn lint to run the linter in all packages
• yarn test to run tests in all packages
• yarn docs to generate API documentation

Application

The SelfID application is available using Ceramic's mainnet on self.id and the Clay testnet on clay.self.id.

SDK

Documentation

Packages

Self.ID packages are organized in the following stack:

┌─────────────────────────────┐ ┌─────────────┐
│          framework          │ │ 3box-legacy │
├─────────────┬─┬─────────────┤ └─────────────┘
├─────────────┤ ├─────────────┤
│    react    │ │ image-utils │
├─────────────┤ └─────────────┘
├─────────────┤
│     web     │
├─────────────┤
├─────────────┤
│    core     │
└─────────────┘

| Name | Description | Version | | ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | @self.id/core | Read public records in Node and browsers environments | | | @self.id/web | Read and write records in browsers environments | | | @self.id/react | React hooks and utilities for authentication and records interactions | | | @self.id/image-utils | Image utilities for Self.ID profiles | | | @self.id/framework | React framework for decentralized apps | | | @self.id/3box-legacy | Load legacy 3Box profiles | |

Templates

Predefined setups using common technologies to build applications using the Self.ID SDK.

| Name | Description | | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | next-notes-typescript | Notes taking application setup using Next.js and TypeScript | | webpack-basic | Basic Webpack setup | | webpack-basic-typescript | Basic Webpack setup using TypeScript |

<!-- | [`vite-basic`](./templates/vite-basic) | Basic [Vite](https://vitejs.dev/) setup | -->

Maintainers

• Paul Le Cam (@paullecam)

License

The SDK packages, templates and apps are dual licensed under MIT and Apache 2.