Skip to content

Latest commit

 

History

History
35 lines (20 loc) · 1005 Bytes

CONTRIBUTING.md

File metadata and controls

35 lines (20 loc) · 1005 Bytes

Contributing

Install dependencies:

  • npm install

Build the backend & frontend:

  • npm run build

Run the react development server:

  • npm run start:frontend:dev (visit localhost:3001)

Run the backend:

  • npm run start:server:dev (available on localhost:3000)

Compile executables:

  • npm run compile:x64 for x64 machines (most computers).
  • npm run compile:armv7 for armv7 machines (Raspberry Pi and other single board computers).
  • npm run compile:arm64 for armv64 machines

The executables are located in the bin folder.

TypeScript Migration

We are currently in the process of migrating the code base partially to TypeScript. All new files under src and server should be written in TypeScript.

All new features should be built using TypeScript. Existing features can be ported over to TypeScript by adding changing the file extension from .js to .ts/.tsx.

In case you want to help porting features over to TypeScript, feel free to open an issue or pull request.