Skip to content

Commit

Permalink
docs: add development description
Browse files Browse the repository at this point in the history
  • Loading branch information
Christoph Bühler committed Oct 25, 2022
1 parent 643c6e5 commit 76458b3
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,15 @@ implementations since it handles RSA keys.
This library does _not_ provide authentication helpers for web applications.
If you want to use `passport js` and OAuth 2.0 introspection, head over to
[node-passport-zitadel](https://github.com/buehler/node-passport-zitadel).

### Development

To enhance this library or to fix a bug, you need to do the following:

1. Clone the repository
2. Install the dependencies with `npm install`
3. Install the submodules with `git submodule update --init --recursive`
4. Generate the gRPC types with `npm run build:grpc`

Then you can start developing with `npm run dev`. The production build can be
made with `npm run build` and the tests run with `npm test`.

0 comments on commit 76458b3

Please sign in to comment.