Skip to content

Commit b86fa1f

Browse files
committed
DOC: Up to date instructions to contributors (see #199).
1 parent 72f6490 commit b86fa1f

File tree

1 file changed

+11
-30
lines changed

1 file changed

+11
-30
lines changed

CONTRIBUTING.md

+11-30
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ npm install
3030

3131
## Launching software
3232

33-
Launch the backend:
33+
From the root folder of Hyperglosae, launch the backend:
3434

3535
```shell
3636
export COUCHDB_USER="TO_BE_CHANGED"
@@ -40,7 +40,7 @@ docker compose --file docker-compose.dev.yml up --detach
4040

4141
Open <http://localhost:5984/_utils> to view its Web console.
4242

43-
Compile and launch the frontend:
43+
From the `frontend` folder of Hyperglosae, compile and launch the frontend:
4444

4545
```
4646
npm start
@@ -51,36 +51,16 @@ Don't close the terminal or interrupt the command unless you want to "kill" the
5151
Open <http://localhost:3000> to browse sample data in the application.
5252
To test edit features, log in as user `alice` with `whiterabbit` as the password.
5353

54-
## Installing test tools
55-
56-
Get the name of your shell (`bash`, `zsh`, etc.):
57-
58-
```shell
59-
ps
60-
```
61-
62-
Depending on your shell, add this function to `~/.bashrc`, `~/.zshrc`, or other:
63-
64-
```shell
65-
function cucumber() {
66-
(docker run --rm -v "$(pwd)":/app --tty --net="host" --env APP_HOST="http://host.docker.internal:3000" benel/cucumber-capybara "$@")
67-
}
68-
```
69-
70-
Start a new terminal and test the following command:
71-
72-
```shell
73-
cucumber --help
74-
```
75-
7654
## Running tests
7755

78-
From the main folder of Hyperglosae, type the following command:
56+
From the `frontend` folder of Hyperglosae, type the following command:
7957

8058
```shell
81-
cucumber --fail-fast --quiet --retry 2
59+
npm run test2
8260
```
8361

62+
Select `E2E testting`, `Electron`, and then the tests you want to run.
63+
8464
## Developping
8565

8666
### Frontend developping
@@ -94,9 +74,9 @@ You may also see any lint errors in the console.
9474

9575
The backend is coded in JavaScript as CouchDB views (see [documentation](https://docs.couchdb.org/en/stable/ddocs/views/)). Documents stored in CouchDB can be created, updated and deleted (esp. by the frontend) using CouchDB REST API (see [documentation](https://docs.couchdb.org/en/stable/api/document/)).
9676

97-
Everytime you update code in `backend/src`, please push it to the backend with:
77+
Everytime you update code or settings in `backend`, please push them to the backend with:
9878

99-
```sh
79+
```shell
10080
docker compose --file docker-compose.dev.yml run updated_code
10181
```
10282

@@ -105,15 +85,16 @@ And then refresh the frontend (or backend) page.
10585
### Samples writing
10686

10787
Everytime you update sample data in `samples`, please push them to the backend with:
108-
```sh
88+
89+
```shell
10990
docker compose --file docker-compose.dev.yml run updated_samples
11091
```
11192

11293
### Cleaning the data
11394

11495
If (and only if) you want to remove ANY DATA added by hand or through automated tests, launch the following command:
11596

116-
```sh
97+
```shell
11798
docker-compose --file docker-compose.dev.yml down
11899
docker compose --file docker-compose.dev.yml up --detach
119100
```

0 commit comments

Comments
 (0)