Skip to content

Commit

Permalink
Fix name and add numbered steps in guide
Browse files Browse the repository at this point in the history
  • Loading branch information
pstamatop committed Nov 10, 2023
1 parent ebbb4e1 commit 82e5d10
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 28 deletions.
36 changes: 12 additions & 24 deletions docs/development-environment-setup/01-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,30 +26,11 @@ git submodule update --remote
```


See [guide to install ssi-sdk](#a---how-to-generate-an-github-access-token-to-download-the-ssi-sdk-npm-package)
4. Create a github token using the [guide to install ssi-sdk](#a---how-to-generate-a-github-access-token-to-download-the-ssi-sdk-npm-package)

Launch the ecosystem:

```sh
node ecosystem.js up
```


The `up` command will build and start the containers with a default configuration for local development.


Run with `--help` argument for more actions:
```sh
./ecosystem.sh --help
```

To shut down the ecosystem run the following command:

```sh
./ecosystem.sh down
```

### Configure `/etc/hosts`
5. Configure `/etc/hosts`

Add the following lines in the /etc/hosts file:

Expand All @@ -61,7 +42,7 @@ Add the following lines in the /etc/hosts file:
127.0.0.1 wallet-enterprise-acme-verifier
```

### Start the ecosystem
6. Start the ecosystem

For demonstrative purposes, we are going to set up a small ecosystem with:
- 1 Wallet Provider
Expand All @@ -73,20 +54,27 @@ The initial configuration of the legal entities takes place once we start the ec
```sh
node ecosystem.js up -t
```

For more options, see:

```sh
node ecosystem.js up --help
```

To shut down the ecosystem run the following command:

```sh
./ecosystem.sh down
```

## References

### A - How to generate an Github access token to download the ssi-sdk npm package
### A - How to generate a Github access token to download the ssi-sdk npm package

Generate a Git Personal Access Token in order to install GUnet's `ssi-sdk` npm package:

a. Go to https://github.com/settings/tokens

b. Generate a new token with `read:packages` scope

c. Save the token on the `.github-token` file on the root of the `wallet-ecosystem` local repository
c. Save the token on a `.github-token` file on the root of the `wallet-ecosystem` local repository
8 changes: 4 additions & 4 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');

/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'eDiplomas Wallet Ecosystem',
title: 'wwWallet Ecosystem',
tagline: 'Get started with Issuing and Verifying credentials today!',
favicon: 'img/ediplomasLogo.png',

Expand All @@ -18,7 +18,7 @@ const config = {

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'gunet', // Usually your GitHub org/user name.
organizationName: 'wwWallet', // Usually your GitHub org/user name.
projectName: 'wallet-start', // Usually your repo name.

onBrokenLinks: 'throw',
Expand Down Expand Up @@ -60,7 +60,7 @@ const config = {
// Replace with your project's social card
image: 'img/ediplomasLogo.png',
navbar: {
title: 'eDiplomas Wallet Ecosystem',
title: 'wwWallet Ecosystem',
logo: {
alt: 'eDiplomas Logo',
src: 'img/ediplomasLogo.png',
Expand Down Expand Up @@ -91,7 +91,7 @@ const config = {
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} eDiplomas Wallet, Inc.`,
copyright: `Copyright © ${new Date().getFullYear()} wwWallet, Inc.`,
},
prism: {
theme: lightCodeTheme,
Expand Down

0 comments on commit 82e5d10

Please sign in to comment.