NAS Notesbook 📔

Current release: V07 (v7.0.0)

Download NASbook V07 for Windows

NAS Notesbook is SUFYAN's personal, RTL-first, local-first desktop notebook for ChatGPT prompts, NAS APP project contexts, PowerShell commands, and development notes. Built on Windows using Electron, Vite, React, and SQLite, it runs fully offline as a fast, lightweight writing and reference tool.

v1 is intentionally minimal and personal—not a generic note app for IT admins or general users.

---

v1 Features

Capability	Included
Create / edit notes	✓
Delete to Trash / restore	✓
Categories	✓
Global note search	✓
RTL/LTR handling (RTL-first)	✓
Rich text editor (Tiptap)	✓
Collapsible heading sections	✓
Read-only edit lock	✓
16 fill colors with automatic contrast	✓
Code blocks (always LTR)	✓
Copy note content	✓
Copy as ChatGPT context	✓
Import .md / .txt	✓
Export Markdown	✓
Autosave	✓
Local backup folder	✓
Google Drive backup (optional)	✓

Not in v1: automatic real-time cloud sync (Dropbox, OneDrive, NAS sync), Gmail/email backup, restore-from-cloud, multi-device database merge, multi-user support, attachments, encryption, or Notesnook feature parity. Google Drive backup is manual-only and requires a local OAuth configuration.

---

Highlights

• RTL-First Editing: Arabic-first rendering with auto bi-directional block alignment and manual direction overrides. Code blocks and scripts always stay strict LTR.
• Workflow Categories: Prompts, ChatGPT Instructions, NAS Projects, PowerShell Commands, Development Notes, Errors & Fixes, and Templates.
• Local-First: Notes live in a local SQLite database. No telemetry or mandatory network dependencies.
• ChatGPT Copy Commands:
  • Copy Note Content — clean text or markdown.
  • Copy as ChatGPT Context — wraps notes in an XML block for model prompts:

    <context name="Note Title">
    Note Markdown Content Here
    </context>

• Comfortable Editor Width: Full panel width for long prompts and technical notes (no narrow hard-cap in v1).
• Simple Local Backup: Copy notes as Markdown into a user-chosen local folder. No cloud sync integration.
• Google Drive Backup (v0.3.0): Optional manual backup upload using a local OAuth configuration. Credentials and session tokens are encrypted and stored locally; they are never bundled with the installer. For configuration steps, see Google_Credentials_Setup.md.
• Automatic Updates (V07): Installed Windows copies check GitHub Releases in the background, download a newer verified installer, and apply it during a normal safe exit.

---

Install on Windows

1. Open the latest GitHub Release.
2. Download NASbook-Setup-V07.exe.
3. Close any older NASbook process and run the installer.
4. Launch NASbook and confirm that your existing notes are present.

V07 is the first update-enabled release. Users coming from V06 must install V07 manually once; future releases can then arrive through the application. Application updates preserve the existing local notes database, but keeping an independent backup remains recommended.

Windows builds are currently unsigned and may show a reputation warning. Install only assets downloaded from this repository's Releases page.

---

Technology Stack

• Runtime Framework: Electron
• Build Pipeline Engine: Vite + TypeScript
• User Interface Library: React 18 + Tailwind CSS
• Core WYSIWYG Text Editor: Tiptap Editor
• Database Engine: SQLite via Better-SQLite3 (WAL mode)
• Search Engine: Bounded, case-insensitive SQLite title/content queries
• Build Assembly: Electron-builder

---

Documentation

Document	Contents
01_Project_Registry.md	Product intent, v1 scope, RTL rules, data model, backup policy
02_Product_Architecture.md	Process boundaries, SQLite schema, IPC contracts, build pipeline
03_UI_UX_Spec.md	Layout dimensions, color palette, RTL CSS, component interactions
04_Phase_Implementation_Plan.md	Seven-phase implementation blueprint
Google_Credentials_Setup.md	Google Cloud Console setup, minimal scopes, troubleshooting, and manual QA checklist

---

Getting Started (Development Setup)

Prerequisites

Node.js (v18+) and C++ build tools for better-sqlite3 native bindings. On Windows:

npm install --global --production windows-build-tools

Install & Run

cd "C:\Projects\NAS Notesbook"
npm install
npm run dev

Build

npm run build

Output lands in ./dist-build with icon assets/icon.ico.

Validate a change

npm ci
npm run lint
npm run typecheck
npm test
npm run build

Security and contributing

• Notes are stored locally in SQLite; normal note editing does not require a remote service.
• Google Drive backup is optional and uses locally supplied OAuth configuration.
• Do not publish notes, database files, OAuth credentials, session tokens, or personal logs in issues.
• Report vulnerabilities privately using SECURITY.md.
• Development changes target develop; see CONTRIBUTING.md before opening a pull request.

---

License & Copyright

All architectural specifications, designs, and software assets are reserved for proprietary use under the NAS Notesbook local deployment agreements.