Skip to content

Latest commit

 

History

History
26 lines (22 loc) · 2.45 KB

DEVELOPER.md

File metadata and controls

26 lines (22 loc) · 2.45 KB
Raw

Development environment documentation

Required technologies and tools

  • Node Package Manager (NPM): a package management system used to maintain packages used by the application. NPM 3 or higher is required.
  • Gulp: a build system used to build the application.
  • Electron: The app is built with Electron v10.4.7.
  • Node.js (v14.x is required).
  • Visual Studio Code is a good choice as an editor: it's cross-platform and is actually built on top of Electron. That said, everything can be used.

To manage multiple versions of Node.js &/or npm, consider using a node version manager.

How to build and run the application

The following are the commands to run the application. After checking out the repo:

  1. To install node dependencies: npm install
  2. To install gulp: npm install -g gulp (it's easiest to have it installed globally)
  3. To build the UI: gulp or gulp build
  4. To run it: npm start
  5. To run tests: npm test
  6. To build and create a developer .exe file: gulp package

Useful commands and properties

  • gulp watch: it will automatically detect when you save a file and run the corresponding build task so you only have to refresh the app when developing.
  • --no-sandbox: the property --no-sandbox has been inserted to npm start to disable sandbox mode to prevent GPU mismanagement errors, caused by Electron conflicts, during virtualization on a Linux operating system. It is necessary, however, that this property be entered while starting the built program from the terminal. For example, starting the AppImage from the terminal we would type ./NomeAppImage --no-sandbox. This way, the application will be started without any problems.

Latest builds

The master branch is built automatically on git pushes and the output, for successful builds. Please find the artifacts by clicking in the run of the Package workflow.

These builds represent ongoing work. They have not been fully tested and are not guaranteed to work. Normally, you are advised to use one of the releases.