Skip to content

Latest commit

 

History

History
25 lines (21 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

25 lines (21 loc) · 1.51 KB

Metashine contribution guide

Development

  1. Enter development environment nix develop or make sure node 16 npm 8 and rust 1.62 are installed.
  2. Navigate to the native-addon package cd packages/native-addon
  3. Build the Rust library: nix build .#86_64-unknown-linux-gnu or nix build .#86_64-pc-windows-gnu with nix; or cargo build --release without nix.
  4. Package native-addon node scripts/package.mjs
  5. If compiled with nix build remove ./result or electron-builder will bug out.
  6. Navigate to the electron-app package cd ../electron-app
  7. Install dependencies npm i
  8. Start the app in dev mode node scripts/dev.js

Building

  1. Enter development environment nix develop or make sure node 16 npm 8 and rust 1.62 are installed.
  2. Navigate to the native-addon package cd packages/native-addon
  3. Build the Rust library: nix build .#86_64-unknown-linux-gnu or nix build .#86_64-pc-windows-gnu with nix; or cargo build --release without nix.
  4. Package native-addon node scripts/package.mjs
  5. If compiled with nix build remove ./result or electron-builder will bug out.
  6. Navigate to the electron-app package cd ../electron-app
  7. Install dependencies npm i
  8. Build JS artifacts npm run build
  9. (Optional) Preview the app in prod mode npm run preview . or electron . if Electron is natively installed (is is in nix)
  10. Build the app with electron builder npm run compile (you can do this step in the electron-builder's docker image based container). Output wil be found in ./dist