Skip to content

Commit 3d2a536

Browse files
authored
Added contribution instructions
1 parent 478e5fb commit 3d2a536

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# How to contribute
2+
3+
## Requirements
4+
5+
- node 14.4 - Tested on 14.4 and 14.19. Unluckily there are [dev server issues with more recent versions](https://stackoverflow.com/questions/69692842/error-message-error0308010cdigital-envelope-routinesunsupported).
6+
- make (recommended)
7+
8+
## Installation
9+
10+
```bash
11+
make install
12+
```
13+
14+
This will install both the package and the example application.
15+
16+
## Running
17+
18+
```bash
19+
make start
20+
```
21+
22+
This will run a local development server with live-reload capabilities.
23+
24+
## E2E tests
25+
26+
```bash
27+
e2e_open
28+
```
29+
30+
Open the Cypress user interfare for running E2E tests interactively.

0 commit comments

Comments
 (0)