lights-react-out ·

Lights out game implemented with reactjs. The current version can be played at Lights out game.

What's Lights out game?

Lights out game consists of a N by N grid of lights. When the game starts, a random number or a stored pattern of these lights is switched on. The game goal is to switch all the lights off, preferably in a few button presses as possible.

And... How can user play? Pressing any of the lights will toggle it and the adjacent lights. So... Are you ready to solve the puzzle and overcome your own movement record? 💪 🏆

Game development technologies

This game is implemented with reactjs. But... what else? Well, we also have used:

• Nodejs (version >= 8)

• Npm

• Webpack:

  • Babel

• Continuous integration and deployment:

  • circleci: It provides us automation servers where we can implement jobs to test and deploy the application in different Operating system.
  • coveralls: Tool that allow to see the test coverage provided by istanbul.

Documentation

You can find the React documentation on the website.

The documentation is dynamic. It is generated with JSDoc 3. You can improve it by sending pull requests to this repository. The documentation is set into the code comments (You can see tags like @constructor, @name, @description...).

Style

Commit messages

It should match the pattern:

[LRO-{issuenr}][{type}] {commit description}.

• Style refactor in example.js file (this is optional)
• Updated README file to add style section (this is optional)

Where:

• {type}: Conventional commit type.
• {issuenr}: Is the GitHub issue number.
• {commit description}: Simple description to indicate what relevant changes have been done.

Filename convention

If we need to include multiple words into a filename, then we will separate them using a dot ('.'). Example: hello.world.js

Github

Authentication

We are signing Github commits with GPG.

Hooks

Precommits

• Lint: Each time we push a commit into Github project, the precommit hook triggers the eslint script, so if there is any eslint problem in the code changes, user will not be able to commit the changes.

  The eslint configuration can be found in the .eslintrc.json config file.

Licence

Lights react out game is MIT licensed.