Build Status TravisCI | Build Status CircleCI | Code Coverage | Dependabot | Vulnerabilities | Lint Code Base |
---|---|---|---|---|---|
The famous Rock-Paper-Scissors Game now as electron app!
You already know them by heart I guess. But just in case, here they are.
- Clone or download this repo
- Open up a terminal in the project directory and hit:
yarn install
(What does yarn install do?)yarn start
(runs the start script from the package.json)
- Use
yarn upgrade <package>
to upgrade a specific dependency - Use
yarn upgrade
to upgrade all existing dependencies
- Open the project in VSCode/IntelliJ/WebStorm (or whatever you prefer) to explore the code
- Collaborate with me and create a PR with some awesome new features, UI improvements or bug-fixes.
Find the current list of open ideas here.
To execute the Jest tests simply hit:yarn test
or just jest
The electron-builder lets you package and build a ready-made distribution for macOS, Windows and Linux.
Run yarn dist
to create a dmg, windows installer or deb package.
This project contains the following devDependencies:
- Electron itself
- electron-builder to package and build a ready distribution Electron app
- Jest for Testing
- Jest-extended for adding additional matchers to Jest's default ones (making it easy to test everything)
- Jest-Chain for adding expressive assertions and chaining matchers
- JSHint as static code analysis tool for detecting errors and potential problems in the JavaScript code
- Codecov to generate code coverage reports