Notate Logo

Getting Started

Before installing Notate, ensure your system meets the following requirements:

System Requirements

Local Only Mode

  • Python 3.12 (required)
  • At least 10GB of free disk space
  • Minimum 16GB RAM recommended
  • CPU: 4 cores or more
  • GPU recommended for local model inference (10GB+ VRAM)

External Requirements

  • Python 3.12 (required)
  • OpenAI API key (for OpenAI models)
  • Anthropic API key (for Claude models)
  • Google API key (for Google models)
  • XAI API key (for XAI models)
  • Configure in settings after installation

Operating System Requirements

Supported Systems

  • macOS 10.15 or later (Intel/Apple Silicon)
  • Windows 10/11
  • Linux (Ubuntu 20.04 or later)

Development Tools

  • Git for version control
  • VSCode or similar IDE recommended
  • Python virtual environment tool (venv, conda)
  • Package manager: npm or pnpm

Installation Options

Compiled Binaries

Pre-compiled binaries for easy installation are coming soon! Check back for:

macOS

  • .dmg installer (Apple Silicon)
  • .dmg installer (Intel)

Windows

  • .exe installer
  • .msi installer

Linux

  • .AppImage package
  • .deb package

Install from Source

Clone and Setup

Clone the repository:

git clone https://github.com/CNTRLAI/Notate.git

Navigate to frontend directory:

cd notate/Frontend

Install dependencies:

npm install

Build the frontend:

npm run build

Development Mode

macOS
npm run dev:mac
Windows
npm run dev:win
Linux
npm run dev:linux

Production Build

macOS
npm run dist:mac
Windows
npm run dist:win
Linux
npm run dist:linux

Running the Application

After building, you can find the compiled application in the following locations based on your platform:

macOS

Apple Silicon

Application: Notate/Frontend/dist/mac-arm64/Notate.app

Installer: Notate/Frontend/dist/Notate.dmg

Intel

Application: Notate/Frontend/dist/mac/Notate.app

Installer: Notate/Frontend/dist/Notate.dmg

Windows

Executable: Notate/Frontend/dist/Notate.exe

Installer: Notate/Frontend/dist/Notate.msi

Linux

AppImage: Notate/Frontend/dist/Notate.AppImage

Debian Package: Notate/Frontend/dist/Notate.deb

Choose the appropriate installer or executable for your system. The application includes all necessary files to run Notate.