Skip to content

Commit 8b85448

Browse files
jonkoopspskopek
andauthored
Add basic test suite setup (keycloak#55)
Closes keycloak#53 Signed-off-by: Jon Koops <jonkoops@gmail.com> Signed-off-by: Peter Skopek <pskopek@redhat.com> Co-authored-by: Peter Skopek <pskopek@redhat.com>
1 parent 243f1a9 commit 8b85448

16 files changed

Lines changed: 2060 additions & 209 deletions

CONTRIBUTING.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
1-
# Keycloak Javascript adapter
1+
# Keycloak JS
22

3-
Client-side JavaScript library that can be used to secure web applications.
3+
Most of the contribution rules from the [main Keycloak repository](https://github.com/keycloak/keycloak/blob/main/CONTRIBUTING.md) apply Keycloak JS as well. Documented below are steps unique to the development of Keycloak JS.
44

5-
Most of the contribution rules from the [main Keycloak repository](https://github.com/keycloak/keycloak/blob/main/CONTRIBUTING.md) applies to the
6-
Keycloak Javascript adapter as well. Below some rules specific to javascript adapter.
5+
## Prerequisites
76

8-
## Building and working with the codebase
7+
- [Node.js](https://nodejs.org/en/download) (latest LTS or greater)
8+
- [Podman](https://podman.io/) (for testing)
99

10-
TODO
10+
## Setup
1111

12+
Make sure that all dependencies are installed by running the following command in the root of the project:
13+
14+
```sh
15+
npm install
16+
```
17+
18+
## Running the tests
19+
20+
To run the tests, follow the instructions in the [test directory](./test/README.md).

0 commit comments

Comments
 (0)