From 4938f853d50ad2edd89abb5cd95578696dbe7ef2 Mon Sep 17 00:00:00 2001 From: Thomas Citharel Date: Wed, 16 Oct 2019 11:20:30 +0200 Subject: [PATCH] Improve docs a bit Signed-off-by: Thomas Citharel --- support/guides/development/development.md | 2 +- support/guides/development/tests.md | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/support/guides/development/development.md b/support/guides/development/development.md index b1fca76d5..56a9cb14e 100644 --- a/support/guides/development/development.md +++ b/support/guides/development/development.md @@ -39,4 +39,4 @@ Just run : ```bash 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`. diff --git a/support/guides/development/tests.md b/support/guides/development/tests.md index 003a01d3b..bb46b2f97 100644 --- a/support/guides/development/tests.md +++ b/support/guides/development/tests.md @@ -9,6 +9,8 @@ To launch all the tests: mix test ``` +> If you're using Docker, you can use `make test` + If you want test coverage: ```bash @@ -41,6 +43,11 @@ Not done yet. 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 ```bash npx cypress run