Skip to content

hyperledger/identus-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Identus documentation website

This website is built using Docusaurus 2.

Structure

The documentation folder is split into the following parts:

  • docs
  • tutorials
  • sdk
  • api

docs: general documentation

documentation/docs is a general documentation directory for:

  • Getting started guides
  • SSI and Identus concepts
  • Identus architecture and components description

tutorials: general Identus tutorials

documentation/tutorials directory assigned to contain all tutorials about essential topics and protocols Identus is supported, for example:

  • Credential issuance
  • Verification
  • DIDs
  • etc.

sdk: SDKs documentation

documentation/sdk is a special directory for SDK documentation, user guides, and examples. There are two subfolders:

  • enterprise-sdk: for what we call now "Enterprise SDK"
  • wallet-sdk: for what we call now "Wallet SDK"

api: autogenerated docs from OpenAPI specs

documentation/api directory contains auto-generated documentation for RestAPI endpoints provided by Identus executables, it's auto-generated and should not be added manually.

Installation

Here are the simple installation instructions for MacOS to start from the very scratch.

# Install brew, git, node and yarn
# If you have these tools, skip these steps
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install git
brew install node
brew install yarn

# Create new projects directory
cd ~ && mkdir projects && cd projects
git clone https://github.com/hyperledger/identus-docs.git
# Initialize submodules
git submodule init
# Update submodules
git submodule update --remote --recursive

# Use this step to checkout custom branch to review from PR
# git checkout feature-branch

# Deploy local version of the website
cd identus-docs
yarn install
yarn start

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build --out-dir infra/website

This command creates a set of static resources which can be hosted to serve the full site.