How to develop
Start with running
npm test to run tests.
npm run lint to check for code errors
npm run electron-dev to run application in developer mode with live update
(Node version used:
8.4.0, others (newer versions) may work as well.)
Make sure your editor of choice has plugins for ESLint and Prettier installed (for VSCode these are recommended: ESLint, Prettier), because then it will give a lot of hints for what the linter complains about.
How to name branches and git flow
Tasks can be found in Projects.
Assign one to yourself then create branch from develop and name it
Note: feature is an example, it could be:
Commit messages should start with task ID
#5 update README. Explained naming.
Push when done. Make pull request where you add task ID to beginning of comment.
- Learn Node - Learning Path
- Node JS Docs
- How to Learn React — A roadmap from beginner to advanced
Code style & lint
- Source - Source of log data, e.g. files, console output.
- Adapter - A module specialized for reading a particular kind of input
- Engine - Aggregates and buffers data
- Display - UI display device
- Export - Exports data to other formats
|Generator change||Adapter reads||Engine notifies listeners||Listeners can read change if relevant|
|Device reads block||Adapter reads||Engine notifies listeners||Listeners can read change if relevant|
|Complete scan with filter||Adapter reads||Engine notifies listeners||Listeners can read change if relevant|
|Display/Export requests data at position||Engine notifies Adapter||Adapter starts random input cycle|
|Display/Export requests full data scan||Engine notifies Adapter||Adapter starts scan input cycle|