Improve docs a bit

Signed-off-by: Thomas Citharel <tcit@tcit.fr>
This commit is contained in:
Thomas Citharel 2019-10-16 11:20:30 +02:00
parent 7b23ca6965
commit 4938f853d5
No known key found for this signature in database
GPG key ID: A061B9DDE0CA0773
2 changed files with 8 additions and 1 deletions

View file

@ -39,4 +39,4 @@ Just run :
```bash ```bash
make start make start
``` ```
to build and launch a database container and an API container running on localhost. to build and launch a database container and an API container running on `localhost:4000`.

View file

@ -9,6 +9,8 @@ To launch all the tests:
mix test mix test
``` ```
> If you're using Docker, you can use `make test`
If you want test coverage: If you want test coverage:
```bash ```bash
@ -41,6 +43,11 @@ Not done yet.
We use [Cypress](https://cypress.io) for End-to-end testing. We use [Cypress](https://cypress.io) for End-to-end testing.
You first need to run the webserver with the `e2e` environment: `MIX_ENV=e2e mix phx.server`. The same environment parameters as the `dev` environment must be provided.
This allows to run database operations in the sandbox and not pollute your database.
Then, run `MIX_ENV=e2e mix run priv/repo/e2e.seed.exs` to have some initial data inside your instance for the tests.
When inside the `js` directory, you can do either When inside the `js` directory, you can do either
```bash ```bash
npx cypress run npx cypress run