Skip to content

Commit

Permalink
Additional documentation on port, cypress doc, pr and overview of setup
Browse files Browse the repository at this point in the history
  • Loading branch information
Russom Woldezghi committed Mar 19, 2020
1 parent 96a721c commit 4c09bf9
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,17 @@ You will see the build errors and lint warnings in the console.

When you run the start script `yarn start`, code quality (linting) tests are automatically run and feedback is provided in the terminal.

Cypress is installed for end-to-end testing. You can run the tests by running `yarn cypress`. This will open an Electron binary to run end-to-end testing. See `cypress` folder to view tests.
Cypress is installed for end-to-end testing. You can run the tests by running `yarn cypress`. This will open an Electron
binary to run the end-to-end testing. You can then run a specific test or run all tests using "Run all specs" link.
See `cypress/integration` folder to view tests.

**Note**: Cypress is testing the following path, to run the test suites: `http://localhost:3000`. This is set at `cypress.json` in the root folder.

For more information on Cypress, see here: https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Cypress-Can-Be-Simple-Sometimes
**Note**:
- Cypress is configured to run the test suites on: `http://localhost:3000`.
This is set in the `cypress.json` configuration file, `baseUrl` value. You might need to close any other existing scripts using port `3000`.

For more information see:
- Cypress documentation: https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Cypress-Can-Be-Simple-Sometimes
- Pull Request adding Cypress: https://github.com/palantirnet/federated-search-react/pull/68
## Code quality

### Linting
Expand Down

0 comments on commit 4c09bf9

Please sign in to comment.