Skip to content

A serverless technical note-taking app. Features include offline storage (IndexedDB), image attachments, a built-in image cropper, and a responsive 3-panel layout.

License

Notifications You must be signed in to change notification settings

webdev-jason/Note-Vault

Repository files navigation

GitHub last commit Electron JavaScript IndexedDB GitHub license

🏛️ Note Vault

A standalone, Electron-based desktop application for managing technical inspection notes. Designed for QA, manufacturing, and engineering workflows, it prioritizes data privacy by running entirely offline using IndexedDB for storage.

✨ Features

  • 🔒 Offline & Private: All data is stored locally in IndexedDB. No cloud servers or internet connection required.
  • 👤 Profile Management: Create, switch, and delete multiple profiles (e.g., "Work", "Personal") to keep datasets organized.
  • 🖼️ Advanced Image Tools:
    • Smart Compression: Images are automatically optimized on upload to save storage.
    • Precision Cropper: Built-in 1:1 cropper with zoom and pan for detailed inspection shots.
  • 📄 PDF Export: Native integration to print formatted notes directly to PDF.
  • 💾 Import / Export: Backup your entire profile to a JSON file for easy data transfer between machines.
  • ⚡ Three-Panel Layout:
    • List: Browse notes with live previews and real-time filtering by Part ID.
    • Viewer: Large, read-only view for thorough inspection.
    • Editor: Full control over text, images, and captions.

🛠️ Tech Stack

  • Framework: Electron (Desktop Wrapper)
  • Frontend: Vanilla HTML5, CSS3, JavaScript (ES6+)
  • Storage: IndexedDB (Client-side database)
  • Styling: CSS Variables, Grid, and Flexbox (with Dark Mode support)

🚀 How to Install & Run

1. Prerequisites

You must have Node.js installed on your system to build and run the app.

2. Installation & Setup

Clone the repository and install the dependencies:

# Clone the repo
git clone [https://github.com/webdev-jason/Note-Vault.git](https://github.com/webdev-jason/Note-Vault.git)

# Go into the app folder
cd Note-Vault

# Install dependencies
npm install

3. Running the App

Launch the application in development mode:

npm start

👤 Author

Jason Sparks - GitHub Profile

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

About

A serverless technical note-taking app. Features include offline storage (IndexedDB), image attachments, a built-in image cropper, and a responsive 3-panel layout.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published