Skip to content

Commit

Permalink
Merge branch 'develop' into feature/MYEN-545-add-accepted-roles-to-co…
Browse files Browse the repository at this point in the history
…nfig
  • Loading branch information
jrhender committed Jan 21, 2021
2 parents 8d314a0 + 183eb17 commit 9789968
Show file tree
Hide file tree
Showing 27 changed files with 8 additions and 26,877 deletions.
27 changes: 4 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,7 @@

## Getting Started

This repository consists of a Node.js Password Strategy and examples which show how the strategy can be used.

The strategy provides verification of the issuance of claims made regarding roles defined in an Ethereum Naming System (ENS).

The examples consists of both server application which demonstrate the use of the strategy.
This repository consists of a Node.js Password Strategy which provides verification of the issuance of claims made regarding roles defined in an Ethereum Naming System (ENS).

### Prerequisities

Expand All @@ -21,24 +17,9 @@ nodejs version 10+
npm run build
```

### Running the examples
Two server examples are provided: a NestJS example and an ExpressJS example.

The examples can be started in a single command which builds the passport strategy and starts the respective server.

To run the NestJS example:
```
npm run example:nest
```

To run the ExpressJS example:
```
npm run example:express
```

### Client examples
Example clients which demonstrate interaction with the strategy can be found in the [iam-client-lib repo](https://github.com/energywebfoundation/iam-client-lib/tree/develop/examples)

### Example applications
Example server applications which demonstrate the use of the passport strategy can be found in [this repository](https://github.com/energywebfoundation/iam-client-examples).
The repository also contains client examples which leverage the [iam-client-lib](https://github.com/energywebfoundation/iam-client-lib/) to interact with the server applications.

## Active Maintainers
- [Mani H.](https://github.com/manihagh>)
Expand Down
25 changes: 4 additions & 21 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,7 @@

## Getting Started

This repository consists of a Node.js Password Strategy and examples which show how the strategy can be used.

The strategy provides verification of the issuance of claims made regarding roles defined in an Ethereum Naming System (ENS).

The examples consists of both client and server components.
This repository consists of a Node.js Password Strategy which provides verification of the issuance of claims made regarding roles defined in an Ethereum Naming System (ENS).

### Prerequisities

Expand All @@ -28,19 +24,6 @@ nodejs version 10+
npm run build
```

### Running the examples
Two different examples are provided, each using a different server application but the same client application. The two server examples provided are: a NestJS example and an ExpressJS example.

The examples can be started in a single command which builds the passport strategy and starts both the client and respective server.

To run the NestJS example:
```
npm run example:nest
```

To run the ExpressJS example:
```
npm run example:express
```

TODO: Add screenshots of expect result of examples
### Example applications
Example server applications which demonstrate the use of the passport strategy can be found in [this repository](https://github.com/energywebfoundation/iam-client-examples).
The repository also contains client examples which leverage the [iam-client-lib](https://github.com/energywebfoundation/iam-client-lib/) to interact with the server applications.
34 changes: 0 additions & 34 deletions examples/server/express/.gitignore

This file was deleted.

49 changes: 0 additions & 49 deletions examples/server/express/Dockerfile

This file was deleted.

8 changes: 0 additions & 8 deletions examples/server/express/docker-compose.prod.yml

This file was deleted.

30 changes: 0 additions & 30 deletions examples/server/express/index.js

This file was deleted.

Loading

0 comments on commit 9789968

Please sign in to comment.