Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 2.8 KB

README.md

File metadata and controls

42 lines (28 loc) · 2.8 KB

Getting Started

npm install -g yarn 
yarn install --frozen-lockfile
yarn start 

Browse to http://localhost:8080/ to view your app.

The application will automatically reload on file change. Note this is a full reload, not a hot module replacement.

Code quality

This project has a lint config which tries to avoid writing bugs combined with a config which ensures consistent code style. Running yarn lint which automatically reformat your code and fix some lint errors.

# Run linter with autofix
yarn lint

The linter is Eslint with the configuration of create-react-app. Prettier is integrated in eslint to automatically provide a consistent code style.

Testing

By default yarn test will only run the tests related to changed files. Press a to run all tests or press enter to rerun the tests. Read the tools "usage" output to see other run options.

# Starts test runner in watch mode
yarn test

The test runner is Jest which provides support for test coverage reporting, mocks and snapshot testing.

Background

Consider this code as inherited code from previous developers. This means you can't make any assumptions on the fitness of the code. It might be incorrect, unmaintainable, untestable, incomplete or just plain bad. Feel free to improve some or all of it.

This folder contains a Battleship game implemented in vanilla JavaScript with a React interface. A basic Webpack with Babel configuration is used instead of a more complex approach. Importing CSS in JavaScript is supported and exposed as global CSS. Currently the application does not have much CSS.

License

BattleJSip by Xpirit Netherlands BV is licensed under CC BY-SA 4.0