A documentation site for the Aries JavaScript ecosystem.

Last update: Nov 16, 2022

Overview

Aries JavaScript Documentation

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).

Comments

docs(tutorial): agent setup
Draft of the agent setup

Interested to hear about the structure as it might not be the easiest to understand with the massive config file

@TimoGlastra I also assigned you, mainly for correctness of my statements about the config file.
opened by blu3beri 6
docs: 0.2.x to 0.3.x migration guide
An initial version of 0.2.x to 0.3.x migration guide. It currently covers:

Agent constructor changes

Modules extracted from the Core (Action Menu and Question Answer)

Discover Features API changes

Ledger API changes

New module/plug-in API (AgentContext, registration, etc.)

Proofs API changes

Proof Storage changes

Any help would be appreciated, especially on Proof Exchange Records as I haven't used its API a lot previously.
opened by genaris 3
feat: add snippet import with section comments
Description

This PR adds the ability to import snippets from a source file, instead of writing it directly in the markdown files themselves. This enables us to run/test the snippets before publishing a new version of the docs.

A runnable/testable piece of code however, often includes a lot of stuff you might not want to display as part of a snippet. That is why this PR also includes a custom mechanism to partially display sections of the source file.

It works like this:

Create a source file

First, create a source file in the /snippets directory. For the sake of this example we'll call the file /snippets/myCoolCode.ts

// start-section-1 const sectionOneStuff = () => { doSomeStuffBro(); // doSomeStuff }; // end-section-1 const notInAnySectionStuff = "bar"; // start-section-2 const sectionTwoStuff = "fooBar"; // end-section-2

As you can see the code is annotated with //start-section-n and //end-section-n comments. These comments define the sections we can later display separately.

Add the snippet to a markdown file

Inside the documentation, you can import the source file as follows:

```typescript myCoolCode.ts ```

This will import the source file, strip all the section related comments, and display the entire file as follows:

const sectionOneStuff = () => { doSomeStuffBro(); // doSomeStuff }; const notInAnySectionStuff = "bar"; const sectionTwoStuff = "fooBar";

Displaying a specific section

In order to display a specific section, simply add section-n after the import, like this:

```typescript myCoolCode.ts section-1 ```

This will give you the output:

const sectionOneStuff = () => { doSomeStuffBro(); // doSomeStuff };

Fallback

This feature also includes a fallback mechanism in case the imported file can't be found. You can define what to display if the file can be found by simply adding a body to the markdown code block like this:

```typescript thisFileDoesNotExist.ts section-1 // Oops, the imported file doesn't seem to exist ```

This will simply render the code block instead of throwing an error at runtime:

// Oops, the imported file doesn't seem to exist

Final remarks

As can be seen in the example snippet, not all lines of code are part of a section. This enables you to define sections that only include what is really relevant to the user. However, be aware that when a source file is imported without specifying a section (using the section-n syntax), these lines will be included in the rendering.

Signed-off-by: Karim Stekelenburg [email protected]
opened by karimStekelenburg 3
feat: standalone code snippets that are testable
Create a connection is fully working and can be tested with yarn dev:connection.

Issue a credential can issue the credential but no offer is received by the holder (further investigation is required)
opened by blu3beri 2
build(deps): bump decode-uri-component from 0.2.0 to 0.2.2
Bumps decode-uri-component from 0.2.0 to 0.2.2.

Release notes

Sourced from decode-uri-component's releases.

v0.2.2

Prevent overwriting previously decoded tokens 980e0bf

https://github.com/SamVerschueren/decode-uri-component/compare/v0.2.1...v0.2.2

v0.2.1

Switch to GitHub workflows 76abc93

Fix issue where decode throws - fixes #6 746ca5d

Update license (#1) 486d7e2

Tidelift tasks a650457

Meta tweaks 66e1c28

https://github.com/SamVerschueren/decode-uri-component/compare/v0.2.0...v0.2.1

Commits

a0eea46 0.2.2

980e0bf Prevent overwriting previously decoded tokens

3c8a373 0.2.1

76abc93 Switch to GitHub workflows

746ca5d Fix issue where decode throws - fixes #6

486d7e2 Update license (#1)

a650457 Tidelift tasks

66e1c28 Meta tweaks

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot will merge this PR once it's up-to-date and CI passes on it, as requested by @TimoGlastra.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 1
build(deps): bump loader-utils from 2.0.2 to 2.0.4
Bumps loader-utils from 2.0.2 to 2.0.4.

Release notes

Sourced from loader-utils's releases.

v2.0.4

2.0.4 (2022-11-11)

Bug Fixes

ReDoS problem (#225) (ac09944)

v2.0.3

2.0.3 (2022-10-20)

Bug Fixes

security: prototype pollution exploit (#217) (a93cf6f)

Changelog

Sourced from loader-utils's changelog.

2.0.4 (2022-11-11)

Bug Fixes

ReDoS problem (#225) (ac09944)

2.0.3 (2022-10-20)

Bug Fixes

security: prototype pollution exploit (#217) (a93cf6f)

Commits

6688b50 chore(release): 2.0.4

ac09944 fix: ReDoS problem (#225)

7162619 chore(release): 2.0.3

a93cf6f fix(security): prototype polution exploit (#217)

90c7c4b chore(release): 2.0.2

8c2d24e fix: base64 generation and unicode characters (#197)

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 1
build(deps): bump loader-utils from 2.0.2 to 2.0.3
Bumps loader-utils from 2.0.2 to 2.0.3.

Release notes

Sourced from loader-utils's releases.

v2.0.3

2.0.3 (2022-10-20)

Bug Fixes

security: prototype pollution exploit (#217) (a93cf6f)

Changelog

Sourced from loader-utils's changelog.

2.0.3 (2022-10-20)

Bug Fixes

security: prototype pollution exploit (#217) (a93cf6f)

Commits

7162619 chore(release): 2.0.3

a93cf6f fix(security): prototype polution exploit (#217)

90c7c4b chore(release): 2.0.2

8c2d24e fix: base64 generation and unicode characters (#197)

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 1
feat: document indyNamespace for ledger config

Also document changes for https://github.com/hyperledger/aries-framework-javascript/issues/1072

This for v0.3.0 onward

related to this issue 1072

tests fail obviously because this need AFJ>=0.3.0 Signed-off-by: Moriarty [email protected]

opened by morrieinmaas 1
build(deps): bump terser from 5.14.1 to 5.14.2
Bumps terser from 5.14.1 to 5.14.2.

Changelog

Sourced from terser's changelog.

v5.14.2

Security fix for RegExps that should not be evaluated (regexp DDOS)

Source maps improvements (#1211)

Performance improvements in long property access evaluation (#1213)

Commits

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 1
introductions and some context

Hi everyone, I'm planning to do a larger PR to fill out the docs more, but wanted to make this smaller one to get some initial thoughts on writing style etc.

I'm also proposing to change the file names 'prerequisites' to 'installation' and 'installation' to 'set up' as it better reflects the written context. For example currently in the doc titled set up (but filename installation) it is said that "this guide assumes you have followed the install guides".

opened by anagoessens 1
docs: add afj updating guide

Adds most of the documentation for migration to 0.2.0. Still need to do the credentials module.

Are there any other breaking changes you have noticed that we shoiuld mention here? We can also add them later as we discover them, but would be good to cover as much as possible.

opened by TimoGlastra 1
[Request]: Gap between basics and pro
Documentation Request

fantastic project! A few notes on the documentation:

I would add an additional part about credentials and how to create a project from the beginning. This is because the documentation and examples about it are either too basic, or too complex and difficult to understand. Starting from this tutorial, what is needed to move forward with development? Example: how to create a project with an entire VC triangle? How to get the credential exchange?

Version

0.2.x

Which platform are you most interested in for documentation?

[X] React Native

[X] Node.JS

Contribute (optional)

[X] Agree

request
opened by teodem 0
[Request]: OOB Documentation for short urls, connection reuse, and connecting with a public did
Documentation Request

I am looking to create documentation for the aforementioned functionality and wanted to discuss where this should be located within the documentation. Currently some of this seems to pertain to the connection section that already exists inside of the tutorial section but am open to hearing about where else it could possibly fit better.

Version

0.2.x

Which platform are you most interested in for documentation?

[ ] React Native

[ ] Node.JS

Contribute (optional)

[X] Agree

request
opened by KolbyRKunz 2
[Request]: API function call list
Documentation Request

A list of API function calls that can be used for Issuer, Wallet Owner and Provider

Version

0.2.x

Which platform are you most interested in for documentation?

[X] React Native

[X] Node.JS

Contribute (optional)

[ ] Agree

request
opened by dnaicker 1
[Request]: Move react hooks documentation to the aries-javascript-docs repository
Documentation Request

Currently the documentation for the react-hooks package is in the extension repo. We should move it to the aries-javascript-docs repo so all docs is in one place.

https://github.com/hyperledger/aries-framework-javascript-ext/tree/main/packages/react-hooks

We can add a new page under the extension repo under the ecosystem tab

Version

0.2.x

Which platform are you most interested in for documentation?

[ ] React Native

[ ] Node.JS

Contribute (optional)

[ ] Agree

request
opened by TimoGlastra 0
[Request]: Setting up dev environment
Documentation Request

I just had a pass through the docs to spin up a agent in node. They are pretty sweet, thanks for that!

It does feel like there is a bit missing though (or maybe I just missed it).

The AFJ library uses TypeScript and es6 modules, which is cool but requires some config to get working.

The docs currently go from:

Install node and npm

Install dependencies for AFJ

Setup AFJ agent

It seems to me that between 2. and 3. there is a step that is something like configure the environment. If folks are installing node, then likely they are going to need to some hints for running a node app (esp with .ts and es6 extra config).

I followed these steps to configure my environment, so at a minimum referencing something like this - https://khalilstemmler.com/blogs/typescript/node-starter-project/

Version

0.2.x

Which platform are you most interested in for documentation?

[ ] React Native

[X] Node.JS

Contribute (optional)

[X] Agree

request
opened by wip-abramson 0

Owner

Hyperledger

GitHub https://aries.js.org

Grupprojekt för kurserna 'Javascript med Ramverk' och 'Agil Utveckling'

JavaScript-med-Ramverk-Laboration-3 Grupprojektet för kurserna Javascript med Ramverk och Agil Utveckling. Utvecklingsguide För information om hur utv

3 May 18, 2022

Hemsida för personer i Sverige som kan och vill erbjuda boende till människor på flykt

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

4 May 3, 2022

Kurs-repo för kursen Webbserver och Databaser

Webbserver och databaser This repository is meant for CME students to access exercises and codealongs that happen throughout the course. I hope you wi

14 Jan 3, 2023

⚗️Nitro provides a powerful toolchain and a runtime framework from the UnJS ecosystem to build and deploy any JavaScript server, anywhere

1.3k Jan 5, 2023

A Very Good Documentation Site created by the Very Good Ventures Team 🦄

Very Good Docs Site Developed with ?? by Very Good Ventures ?? A Very Good Docs Site created by the Very Good Ventures Team. Generated by the Very Goo

8 Nov 2, 2022

2omb ecosystem

?? Welcome to the 2omb ecosystem ?? [ Thanks for taking the time to contribute! You can start by reading our Contribution guidelines first.](url) Setu

3 Feb 20, 2022

Solidex is a list of SolidJS ecosystem resources and packages.

Solidex The following is a list of articles, packages and other resources that focus on the SolidJS ecosystem. Solidex is a platform for listing and m

7 Dec 18, 2022

A tool to get plugin statistics of Obsidian plugin ecosystem.

Obsidian Plugin Stats A tool to get plugin statistics of Obsidian plugin ecosystem. Usage You can use this tool to see the plugins that has hit commun

27 Dec 25, 2022

Internationalization for svelte framework. Based on i18next ecosystem

svelte-i18next Svelte wrapper for i18next npm i svelte-i18next i18next Implementation This library wraps an i18next instance in a Svelte Store to obs

20 Dec 9, 2022

Toolkit for development, test and deploy smart-contracts on Waves Enterprise ecosystem.

JS Contract SDK Toolkit for development, test and deploy smart-contracts on Waves Enterprise ecosystem. Quickstart The fastest way to get started with

20 Dec 15, 2022

A crawler that crawls the site's internal links, fetching information of interest to any SEO specialist to perform appropriate analysis on the site.

Overview ?? It is a module that crawls sites and extracts basic information on any web page of interest to site owners in general, and SEO specialists

2 Apr 22, 2022

A crawler that crawls the site's internal links, fetching information of interest to any SEO specialist to perform appropriate analysis on the site.

Overview ?? It is a module that crawls sites and extracts basic information on any web page of interest to site owners in general, and SEO specialists

2 Apr 22, 2022

Open Source projects are a project to improve your JavaScript knowledge with JavaScript documentation, design patterns, books, playlists.

It is a project I am trying to list the repos that have received thousands of stars on Github and deemed useful by the JavaScript community. It's a gi

22 Aug 14, 2022

This repo has demos, content and documentation of javascript concepts and syntax, in their simplest form. Contribute by sharing your understanding of javascript! Hacktoberfest Accepted!

javascript-documentation open-source hacktoberfest2022 Submit your PR to this javascript-documentation repo ?? ?? ❗ This repo has some of my javascrip

7 Nov 2, 2022

Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

Introduction Swagger UI allows anyone — be it your development team or your end consumers — to visualize and interact with the API’s resources without

23.2k Dec 28, 2022

A documentation site for the Aries JavaScript ecosystem.

Related tags

Overview

Aries JavaScript Documentation

Getting Started

Installation

Local Development

Build

Deployment

Contributing

Licence

Comments

Description

Create a source file

Add the snippet to a markdown file

Displaying a specific section

Fallback

Final remarks

v0.2.2

v0.2.1

v2.0.4

2.0.4 (2022-11-11)

Bug Fixes

v2.0.3

2.0.3 (2022-10-20)

Bug Fixes

2.0.4 (2022-11-11)

Bug Fixes

2.0.3 (2022-10-20)

Bug Fixes

v2.0.3

2.0.3 (2022-10-20)

Bug Fixes

2.0.3 (2022-10-20)

Bug Fixes

v5.14.2

Documentation Request

Version

Which platform are you most interested in for documentation?

Contribute (optional)

Documentation Request

Version

Which platform are you most interested in for documentation?

Contribute (optional)

Documentation Request

Version

Which platform are you most interested in for documentation?

Contribute (optional)

Documentation Request

Version

Which platform are you most interested in for documentation?

Contribute (optional)

Documentation Request

Version

Which platform are you most interested in for documentation?

Contribute (optional)

Owner

Hyperledger

Grupprojekt för kurserna 'Javascript med Ramverk' och 'Agil Utveckling'

Hemsida för personer i Sverige som kan och vill erbjuda boende till människor på flykt

Kurs-repo för kursen Webbserver och Databaser

⚗️Nitro provides a powerful toolchain and a runtime framework from the UnJS ecosystem to build and deploy any JavaScript server, anywhere

A Very Good Documentation Site created by the Very Good Ventures Team 🦄

2omb ecosystem

Solidex is a list of SolidJS ecosystem resources and packages.

A tool to get plugin statistics of Obsidian plugin ecosystem.

Internationalization for svelte framework. Based on i18next ecosystem

Toolkit for development, test and deploy smart-contracts on Waves Enterprise ecosystem.

A crawler that crawls the site's internal links, fetching information of interest to any SEO specialist to perform appropriate analysis on the site.

A crawler that crawls the site's internal links, fetching information of interest to any SEO specialist to perform appropriate analysis on the site.

Open Source projects are a project to improve your JavaScript knowledge with JavaScript documentation, design patterns, books, playlists.

This repo has demos, content and documentation of javascript concepts and syntax, in their simplest form. Contribute by sharing your understanding of javascript! Hacktoberfest Accepted!

Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

API Documentation Browser

Support documentation for Decrypt's applications, token, and community.

Automatically generated documentation for the Valorant API endpoints the client uses internally.

Maintain your API development, documentation and experimentation all within your codebase.