Skip to content

ali-imtiyazkhan/notesKeeper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FileKeeper- Local-first AI Notetaker

Nimble is a simple, privacy-first note app that keeps your notes on your device by default. It works offline. Built-in AI helps you summarize notes, find things quickly, suggest text, and organize with tags. Fast, easy to use, and designed so your data stays private unless you choose to back it up.

Table of Contents

Overview

  • FileKeeper focuses on privacy and fast local-first workflows. Notes are stored locally (filesystem in the browser). When you ask the app to use AI, it collects the array of notes and opens a WebSocket connection to an AI service (address provided via environment). The AI runs online and responds via the WebSocket with summaries, relevance-ranked results, extracted quotes, or answers to general queries. The app works offline for creating and editing notes; AI-powered features require an active network connection to the configured WebSocket endpoint.

Features

  • Local-first storage- Notes live on your device by default; fast read/write and offline editing.
  • AI agents (over WebSocket)- Remote AI agents process your local notes via a WebSocket connection and return results in real time.
  • Relevancy search- Ask questions and get results ranked by relevance across your notes.
  • Quote extraction- Automatically extract key quotes or highlights from multiple notes.
  • General query- Ask the AI broad questions about your notes (summaries, follow-ups, TODO extraction, etc.).
  • Privacy-first design- The UI and storage remain local; only the data you send over WebSocket reaches the AI service.

Dependencies

  • Next.js
  • Bun
  • WebSockets

Git-Setup

Clone the repository:

git clone https://github.com/shaurya35/nimble
cd nimble

Setup

Redirect to FileKeeper:

cd nimble

Install the dependencies:

bun install

Create a .env file:

NEXT_PUBLIC_WS_URL=

Run client Interface:

bun dev

Usage

Access the app in your web browser at http://localhost:3000/.

About

NotKeeper is a full-stack note-taking application designed to help users capture and organize their thoughts seamlessly. It provides features like creating, editing, deleting, and categorizing notes in a simple and intuitive UI. Built with a modern tech stack, the app ensures fast performance, responsive design, and smooth user experience.

Resources

License

Stars

5 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors