Credo Documentation

Getting started  |  Contributing  |  License

Credo is a modular ecosystem of self-sovereign identity development tools written in TypeScript. This documentation site serves to make it as easy as possible for developers of any level to get started with building self-sovereign identity solutions.

Getting Started

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn

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

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

USE_SSH=true yarn deploy

Not using SSH:

GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Contributing

The docs are a work in progress, contributions are incredibly appreciated! If you're looking to contribute check out the contribution guideline.

There are regular community working groups to discuss ongoing efforts within Credo, showcase items you've built with Credo, or ask questions. See Meeting Information for up to date information on the meeting schedule. Everyone is welcome to join!

We welcome you to join our mailing list and Discord channel. See the Wiki for up to date information.

Licence

Credo Documentation is licensed under the Apache License Version 2.0 (Apache-2.0).