Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.08 KB

developer-documentation.md

File metadata and controls

60 lines (38 loc) · 2.08 KB

Developer documentation

Requirements

  • node.js (developed with node version v20.5.1)
  • yarn

Set-up

Clone this repository, go to the root folder of this project and run yarn to install all dependencies.

Commands

Command Description
yarn run dev Start app in development mode
yarn run test Execute tests
yarn run dist Create executable binaries for Mac and Linux
yarn run dist-win Create executable binaries for Windows

Create new release

You will need a mac/linux machine for the mac/linux build and a windows machine for the windows build. Sadly electron-builder can not create builds for all platforms from all platforms. Also our TravisCI automated build pipeline is no longer functional and deactivated.

  1. Update the version by executing one of the following commands:
yarn version --major
yarn version --minor
yarn version --patch

This will update the version in package.json as well as creating a new git tag.

  1. Run git push to push to master and then git push --tags to also include the new tags.

  2. Run yarn run dist from your mac

  3. Run the github action createWindowsBuild and download the file from the action

  4. Create new release (latest release here) and append all build files to the release as well as a zip file containing the source code.

Tech stack

  • Typescript (Typed JavaScript)
  • Electron (Creates desktop application using web technologies)
  • Webpack (Bundles source files and assets)
  • React (for component based UI)
  • MobX (to store application state in observable objects)
  • InversifyJS (dependency injection container)
  • Jest (Testing framework)

Architecture / Layers

See details about the Architecture and Layers here.