Install Now
How to install streetwriters/notesnook. Official installation instructions. Project installation guide. Framework or library installation. Build installation instructions. How to setup and install from GitHub. Installation steps and setup instructions. Official docs and installation instructions GitHub.
streetwriters/notesnook Installation Guide
How to install streetwriters/notesnook. Official project installation instructions and setup guide.
⚡
Automated Install (Recommended)
Quick installation instructions for streetwriters/notesnook. This is the fastest way to complete project installation and setup.
Install via curl
curl -fsSL https://hexmos.com/ipm-install | bash &&
ipm i streetwriters/notesnookor
Install via npx
npx @hexmos/ipm i streetwriters/notesnookPrerequisites
Node.js
languageVersion: >=16.0.0
Required for the monorepo environment. Version 16 or 18 is recommended.
NPM
package_managerVersion: >=8.0.0
Notesnook explicitly uses NPM (not Yarn or PNPM) for its monorepo management.
Git
system_toolUsed to fetch the source code and manage the internal cryptography submodules.
Manual Installation Methods
Manual installation instructions. How to install from GitHub source.
Monorepo Build
git clone https://github.com/streetwriters/notesnook.git
cd notesnook
npm install
npm run bootstrapPost Installation Steps
- To start the web client, run: `npm run start:web` from the root directory.
- To build the desktop app (Electron), run: `npm run build:desktop`.
- To start the mobile development server, navigate to `apps/mobile` and run `npm start`.
- The web app will be accessible at http://localhost:3000 by default.