more clarifications

main
Inga 🏳‍🌈 1 year ago
parent c4abe2ff42
commit 8a36b28fa7
  1. 13
      solution.md

@ -193,6 +193,9 @@ The code is mostly covered by tests.
I did not have any time to come up with good test cases, so most tests work on samples of data from OMDB and on provided sample JSONs. I did not have any time to come up with good test cases, so most tests work on samples of data from OMDB and on provided sample JSONs.
Regular tests (ran with `npm test`) do not have any external dependencies.
Additionally there are tests that connect to remote OMDB API; these are ran with `npm run test:e2e`.
## Git ## Git
The assignment has two contradicting messages: The assignment has two contradicting messages:
@ -202,12 +205,14 @@ but also that you will evaluate the proper use of git.
I decided to go with the first message, and use git to document work history, not to showcase git use that would be proper for PRs in a professional environment. I decided to go with the first message, and use git to document work history, not to showcase git use that would be proper for PRs in a professional environment.
## Configuration
OMDB API token is passed to the app and e2e tests as an environment variable (hardcoded in package.json, but can easily be extracted from there).
# How to use # How to use
To start: `npm run start`; it is available on `localhost:3000` by default. To start: `npm run start`; it is available on `localhost:3000` by default.
To run tests: `npm test`. To run tests: `npm test`, `npm run test:e2e` (see "Testing" section for more details).
To run tests that connect to actual OMDB (these are not included in `npm test`): `npm run test:e2e`.
To lint: `npm run lint`. To lint: `npm run lint` (see "Framework" section for more details).

Loading…
Cancel
Save