Skip to content

Commit fb454bb

Browse files
committed
📝(frontend): propose a condensed version of the frontend README
1 parent 590fd68 commit fb454bb

File tree

2 files changed

+19
-23
lines changed

2 files changed

+19
-23
lines changed

Makefile

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,13 +233,17 @@ run-e2e:
233233
.PHONY: run-e2e
234234

235235
status: ## an alias for "docker compose ps"
236-
@$(COMPOSE_E2E) ps
236+
@$(COMPOSE) ps
237237
.PHONY: status
238238

239239
stop: ## stop the development server using Docker
240-
@$(COMPOSE_E2E) stop
240+
@$(COMPOSE) stop
241241
.PHONY: stop
242242

243+
stop-e2e: ## stop the e2e server using Docker
244+
@$(COMPOSE_E2E) stop
245+
.PHONY: stop-e2e
246+
243247
# -- Backend
244248

245249
demo: ## flush db then create a demo for load testing purpose
@@ -407,9 +411,13 @@ run-frontend-development: ## Run the frontend in development mode
407411
.PHONY: run-frontend-development
408412

409413
frontend-test: ## Run the frontend tests
410-
cd $(PATH_FRONT_IMPRESS) && yarn test
414+
cd $(PATH_FRONT) && yarn test
411415
.PHONY: frontend-test
412416

417+
frontend-test-e2e: ## Run the e2e tests
418+
cd $(PATH_FRONT) && yarn playwright install && yarn e2e:test --project='chromium'
419+
.PHONY: frontend-test-e2e
420+
413421
frontend-i18n-extract: ## Extract the frontend translation inside a json to be used for crowdin
414422
cd $(PATH_FRONT) && yarn i18n:extract
415423
.PHONY: frontend-i18n-extract

README.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -122,28 +122,16 @@ $ make run
122122

123123
⚠️ For the frontend developer, it is often better to run the frontend in development mode locally.
124124

125-
To do so, install the frontend dependencies with the following command:
125+
This is the commands you will need in that order to develop and make your code ready for PR submission :
126126

127127
```shellscript
128-
$ make frontend-development-install
129-
```
130-
131-
And run the frontend locally in development mode with the following command:
132-
133-
```shellscript
134-
$ make run-frontend-development
135-
```
136-
137-
To start all the services, except the frontend container, you can use the following command:
138-
139-
```shellscript
140-
$ make run-backend
141-
```
142-
143-
To execute frontend tests & linting only
144-
```shellscript
145-
$ make frontend-test
146-
$ make frontend-lint
128+
make frontend-development-install # install the frontend dependencies
129+
make run-backend # start all the services, except the frontend container
130+
make run-frontend-development # run the frontend locally on your host in development mode
131+
make frontend-test # execute frontend unit tests
132+
make frontend-lint # execute frontend linting
133+
make run-e2e # start another docker stack for e2e tests
134+
make frontend-e2e # execute frontent e2e tests
147135
```
148136

149137
**Adding content**

0 commit comments

Comments
 (0)