Code Monkey home page Code Monkey logo

self.id's Introduction

SelfID

Monorepo for the SelfID application and SDK.

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

Packages

Self.ID packages are organized in the following stack:

┌─────────────────────────────────────────────┐ ┌─────────────┐
│                  framework                  │ │ 3box-legacy │
├─────────────┬─┬─────────────┬─┬─────────────┤ └─────────────┘
├─────────────┤ ├─────────────┤ ├─────────────┤
│  multiauth  │ │    react    │ │ image-utils │
├─────────────┤ ├─────────────┤ └─────────────┘
├─────────────┤ ├─────────────┤
│     ui      │ │     web     │
└─────────────┘ ├─────────────┤
                ├─────────────┤
                │    core     │
                └─────────────┘
Name Description Version
@self.id/core Read public records in Node and browsers environments npm version
@self.id/web Read and write records in browsers environments npm version
@self.id/react React hooks and utilities for authentication and records interactions npm version
@self.id/ui React UI theme and components npm version
@self.id/multiauth Blockchain authentication for React apps npm version
@self.id/image-utils Image utilities for Self.ID profiles npm version
@self.id/framework React framework for decentralized apps npm version
@self.id/3box-legacy Load legacy 3Box profiles npm version

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
vite-basic Basic Vite setup
webpack-basic Basic Webpack setup
webpack-basic-typescript Basic Webpack setup using TypeScript

Maintainers

License

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

self.id's People

Contributors

decentralgabe avatar paullecam avatar ukstv avatar zachferland avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.