Skip to content

KolbyRKunz/aries-javascript-docs

 
 

Repository files navigation


Hyperledger Aries logo

Aries JavaScript Documentation

License


Getting started  |  Contributing  |  License

Aries JavaScipt is an ecosystem of self-sovereign identity development tools, with Aries Framework JavaScipt at the center. 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.

Issues are also welcomed as it gives us a good idea of the work still needing to be done.

Licence

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

About

A documentation site for the Aries JavaScript ecosystem.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 50.4%
  • JavaScript 43.8%
  • CSS 5.8%