https://github.com/openwallet-foundation/credo-ts-docs
Documentation for Credo
https://github.com/openwallet-foundation/credo-ts-docs
aries aries-framework-javascript aries-framework-javascript-ext aries-mobile-agent-react-native documentation hyperledger-aries javascript ssi
Last synced: 10 months ago
JSON representation
Documentation for Credo
- Host: GitHub
- URL: https://github.com/openwallet-foundation/credo-ts-docs
- Owner: openwallet-foundation
- Created: 2022-05-06T08:44:08.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-05T11:55:58.000Z (over 1 year ago)
- Last Synced: 2024-12-05T12:32:04.964Z (over 1 year ago)
- Topics: aries, aries-framework-javascript, aries-framework-javascript-ext, aries-mobile-agent-react-native, documentation, hyperledger-aries, javascript, ssi
- Language: TypeScript
- Homepage: https://credo.js.org
- Size: 19.6 MB
- Stars: 19
- Watchers: 9
- Forks: 33
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
Credo Documentation
Getting started |
Contributing |
License
[Credo](https://github.com/openwallet-foundation/credo-ts) 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](https://docusaurus.io/), 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= 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](https://github.com/openwallet-foundation/credo-ts-docs/blob/main/CONTRIBUTING.md).
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](https://github.com/openwallet-foundation/credo-ts/wiki/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](https://github.com/openwallet-foundation/credo-ts/wiki/Communication) for up to date information.
## Licence
Credo Documentation is licensed under the [Apache License Version 2.0 (Apache-2.0)](/LICENSE).