Notate Logo

Troubleshooting

Notate is a powerful tool that allows you to create, edit, and share your music notation. It is built on top of the Notate API, which is a RESTful API that allows you to interact with the Notate platform. Notate is a free and open-source software, and it is available on Windows, macOS, and Linux.

🚫App Start-up

Common startup problems and how to find application logs for troubleshooting.

Common Startup Problems

  • Application fails to launch or crashes immediately
  • Blank/white screen on startup
  • Application freezes during initialization
  • Missing dependencies or runtime errors

Log Locations

  • Windows: C:\Users\[Username]\AppData\Roaming\notate\main.log
  • macOS: ~/Library/Application Support/notate/main.log
  • Linux: ~/.config/notate/logs/main.log

Troubleshooting Steps

  • Check the application logs for specific error messages
  • Collect the relevant log file from your system:
  • - Windows: C:\Users\[Username]\AppData\Roaming\notate\main.log
  • - macOS: ~/Library/Application Support/notate/main.log
  • - Linux: ~/.config/notate/logs/main.log
  • Create a new issue on our GitHub repository (github.com/notate/notate):
  • - Use a clear title describing the problem
  • - Describe the steps to reproduce the issue
  • - Include your system information (OS, version)
  • - Attach the collected log file
  • - Add any relevant screenshots or error messages

🛠️Development Issues

Common development-related issues and their solutions when working on Notate.

SQLite Module Version Mismatch

  • If you encounter this error:
  • A JavaScript error occurred in the main process
Uncaught Exception:
Error: The module '/home/[Username]/Notate/Frontend/node_modules/.pnpm/better-sqlite3@11.7.2/node_modules/better-sqlite3/build/Release/better_sqlite3.node'
was compiled against a different Node.js version using
NODE_MODULE_VERSION 127. This version of Node.js requires
NODE_MODULE_VERSION 130. Please try re-compiling or re-installing
the module (for instance, using npm rebuild or npm install).
  • This means the SQLite module needs to be rebuilt for your current Node.js version. Follow these steps to fix it:
  • # Using npm:
  • npm cache clean --force
  • rm -rf ~/.cache/electron
  • rm -rf ~/.cache/electron-builder
  • npm install
  • npx electron-rebuild -f -w better-sqlite3
  • npm run build
  • # Or using pnpm:
  • pnpm store prune
  • rm -rf ~/.cache/electron
  • rm -rf ~/.cache/electron-builder
  • pnpm install
  • npx electron-rebuild -f -w better-sqlite3
  • pnpm run build

Common Development Errors

  • Node module version mismatches
  • Electron native module rebuild issues
  • Development environment setup problems
  • Build and packaging errors