etm12-pixel-app

Contents

• Getting started
• Running tests
• Building
• Code structure

Getting started

You'll need Node.js (a fresh version, anything over 8 but 12 is preferred). Yarn is recommended, but not required.

# Install all dependencies
yarn

# Run app
yarn start

Git hooks

This repository uses husky for Git hooks. All tests must pass to be allowed pushing to remote.

Committing code

This repository uses Git commitizen for creating commit messages in the repository. After installing dependencies, commitizen should also be configured in the project. Use git cz instead of git commit for commits.

Project scripts

• yarn start
  • start application locally with some additional development environment-related additions
• yarn start:app
  • same as yarn start, but skip devenv-related additions
• yarn build
  • create production bundle; yarn prebuild must succeed
• yarn build:changelog
  • generate CHANGELOG.md file based committed code changes
• yarn prebuild
  • run tests and collect code coverage before creating the application bundle
• yarn test
  • run tests in watch mode
• yarn test:simple
  • run tests without watch mode
• yarn test:cov
  • run tests without watch mode, collect code coverage reports

Running tests

• yarn test — Application-wide tests (watch mode)
• yarn test:simple — Application-wide tests without watch-mode
• yarn test:cov — Test and collect code coverage reports

Testing libraries

• unit tests through jest
• snapshot testing as lightweight regression tests for presentation components
• property-based testing through jsverify

Building

The production bundle can be created by running

yarn build

Code structure

• Scope-specific code for a module is located inside the directory _/ located inside that directory
• Tests for a file module.js should be in __tests__/module.js in the same directory