There will be a good description/readme later. But now, this repository is here just for development purposes.
Lerna helps you run yarn
scripts for both projects. Bootstrapping is the first step to install the project dependencies. It will basically run the yarn install
for both projects.
yarn
yarn bootstrap
There is only front end package for now. If you want to run front-end using lerna,
yarn start:frontend
This will kick yarn start
on front end package. You can go to localhost:3000
after running command.
There is a test suite embedded into the project under the tests folder. Test suite is using a 3rd party library called gherkin-testcafe
which is a nice wrapper around testcafe
framework that allows us to create BDD style human-readable tests with Gherkin
format.
In order to run the tests you first need to start the application using
yarn dev
And in order to run the tests locally you can then you can run
yarn e2e-test:chrome:local
This command will set the BASE_URL
environment variable to http://localhost:30000
, which is the base url that the tests will run against. Then, run the testcafe using gherkin-testcafe chrome tests/features/**/*.feature tests/step_definitions/**/*.js
command.
As you might notice the tests will run against Chrome
browser, meaning that the browser should be installed if you want to run the tests in your environment. If you want to run the tests using different browsers then you might find the testcafe documentation useful.
We are using Storybook as a component documentation tool. If you want to see how to use our UI components:
yarn start:storybook
This command will start our documentation page after waiting 10 seconds.
docker-compose run --rm ucurtma-app yarn bootstrap
docker-compose run -d --service-ports ucurtma-app yarn start:frontend
docker-compose run --rm --service-ports ucurtma-app yarn e2e:browserstack
Cross-browser testing provided by: