mirror of
https://github.com/streetwriters/notesnook.git
synced 2026-07-10 04:21:21 +02:00
8f8ac25d20
* desktop: add support for opening file links Signed-off-by: 01zulfi <85733202+01zulfi@users.noreply.github.com> * web: unescape paths with spaces * web: wrap message in confirm dialog Signed-off-by: 01zulfi <85733202+01zulfi@users.noreply.github.com> * desktop: show message box if path doesn't exist when opening file link Signed-off-by: 01zulfi <85733202+01zulfi@users.noreply.github.com> * desktop: disable opening file links on flatpak Signed-off-by: 01zulfi <85733202+01zulfi@users.noreply.github.com> * desktop: wrap long file paths in electron dialog * on linux, long messages in dialog aren't wrapped, so we need to wrap manually Signed-off-by: 01zulfi <85733202+01zulfi@users.noreply.github.com> * desktop: fix persistent "path not found" error * intl: update strings --------- Signed-off-by: 01zulfi <85733202+01zulfi@users.noreply.github.com> Co-authored-by: Abdullah Atta <abdullahatta@streetwriters.co>
Notesnook Desktop
The desktop app is built using Electron & Typescript.
Downloads | Developer guide | How to build?
Getting started
Build instructions
Before you start, it is recommended that you read the contributing guidelines.
Setting up the development environment
Requirements:
Before you can do anything, you'll need to install Node.js v16 or later on your system.
clonethe monorepo:
git clone https://github.com/streetwriters/notesnook.git
# change directory
cd notesnook
- Install dependencies:
# this might take a while to complete
npm install
- Run the webapp for desktop environment:
cd apps/web
npm run start:desktop
- In a separate terminal session, run the desktop app from the root of the project:
npm run start:desktop
Release mode
To run the app in release mode:
npm run staging -- --rebuild
This will compile and run the app in production mode but it won't generate any packages. To create the final packages, you'll have to run the following commands:
npm run release -- --rebuild
# For macOS
npx electron-builder --config=electron-builder.config.js --mac dmg --arm64 --x64 --publish never
# For Linux (AppImage)
npx electron-builder --config=electron-builder.config.js --linux AppImage:x64 AppImage:arm64 --publish never
# For Windows
npx electron-builder --config=electron-builder.config.js --win --publish never
Feel free to play around with the electron-builder command to get the packages you need. npx electron-builder --help is a great resource to learn different commands & platforms supported by electron-builder.
Developer guide
The tech stack
We try to keep the stack as lean as possible:
- Electron
- tRPC: for cross-communication between the web & desktop parts
- zod: for runtime typechecking
- yargs: for CLI argument parsing