docs(specs): update SPECS.md and README.md with Documents and Omnisearch details
This commit is contained in:
parent
1097cd8804
commit
fb519760b5
GPG key ID:
43C1470D890F23ED
2 changed files with 89 additions and 45 deletions
84
README.md
84
README.md
|
|
@ -1,38 +1,74 @@
|
||||||
# sv
|
# QuickNotes
|
||||||
|
|
||||||
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
|
QuickNotes is a personal knowledge management application that allows you to create, manage, and interlink your notes, save articles for later reading, subscribe to RSS/Atom feeds, upload and view PDF documents, and perform a unified full-text search across all your content. The application also includes an Emacs mode for seamless integration directly from your editor.
|
||||||
|
|
||||||
## Creating a project
|
## Features
|
||||||
|
|
||||||
If you're seeing this, you've probably already done this step. Congrats!
|
- **Notes**: Create, edit, and delete notes with Markdown support. Interlink notes using wiki-style syntax and visualize connections with an interactive graph.
|
||||||
|
- **Readlist**: Save and view articles for later reading with automatic content extraction.
|
||||||
|
- **Feeds**: Subscribe to and manage RSS/Atom feeds, and view feed entries with options to mark them as read or unread.
|
||||||
|
- **Documents**: Upload and view PDF documents directly within the app without needing to download them.
|
||||||
|
- **Omnisearch**: Perform unified full-text searches across notes, feed entries, readlist items, and documents.
|
||||||
|
- **Emacs Integration**: Access QuickNotes features directly from Emacs using a dedicated mode.
|
||||||
|
|
||||||
```bash
|
## Technology Stack
|
||||||
# create a new project in the current directory
|
|
||||||
npx sv create
|
|
||||||
|
|
||||||
# create a new project in my-app
|
- **Backend**: Go with the Gin web framework and GORM; SQLite for data storage.
|
||||||
npx sv create my-app
|
- **Frontend**: Svelte with SvelteKit, styled with Bulma CSS and FontAwesome for icons.
|
||||||
```
|
- **Search**: Bleve for full-text search capabilities.
|
||||||
|
- **PDF Viewing**: Integrated PDF.js-like viewer for inline document viewing.
|
||||||
|
- **Package Management**: Bun for frontend dependencies and Go modules for backend dependencies.
|
||||||
|
- **Testing**: Go testing framework for backend and Playwright for end-to-end frontend testing.
|
||||||
|
|
||||||
## Developing
|
## Installation
|
||||||
|
|
||||||
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
|
1. **Server Setup**:
|
||||||
|
- Ensure Go is installed.
|
||||||
|
- Build the backend server using `go build` or the provided `build.sh` script.
|
||||||
|
- Ensure Bun is installed and run `bun install` in the frontend directory.
|
||||||
|
- Start the backend server (default URL: `http://localhost:3000`).
|
||||||
|
|
||||||
```bash
|
2. **Frontend**:
|
||||||
npm run dev
|
- The SvelteKit frontend is served by the Go backend after being built, or can be run separately for development.
|
||||||
|
- Access the application via your web browser at `http://localhost:3000`.
|
||||||
|
|
||||||
# or start the server and open the app in a new browser tab
|
3. **Emacs Integration**:
|
||||||
npm run dev -- --open
|
- Place `quicknotes.el` in your Emacs load path.
|
||||||
```
|
- Add `(require 'quicknotes)` to your Emacs configuration.
|
||||||
|
- Start QuickNotes within Emacs using `M-x quicknotes`.
|
||||||
|
|
||||||
## Building
|
## Usage
|
||||||
|
|
||||||
To create a production version of your app:
|
- Navigate using dedicated pages for Notes, Readlist, Feeds, Documents, and Omnisearch.
|
||||||
|
- Use the Omnisearch page to perform full-text searches across all content domains.
|
||||||
|
|
||||||
```bash
|
### Emacs Mode Key Bindings
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
You can preview the production build with `npm run preview`.
|
- `RET`: Open item
|
||||||
|
- `r`: Mark item as read
|
||||||
|
- `f`: List feeds
|
||||||
|
- `l`: List readlist items
|
||||||
|
- `n`: List notes
|
||||||
|
- `o`: Toggle between HTML and Org mode rendering (using Pandoc)
|
||||||
|
- `g`: Refresh content
|
||||||
|
- `q`: Quit the current buffer
|
||||||
|
|
||||||
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
|
## Documentation
|
||||||
|
|
||||||
|
For detailed specifications, see:
|
||||||
|
|
||||||
|
- [Architecture](specs/architecture.md)
|
||||||
|
- [Notes](specs/notes.md)
|
||||||
|
- [Readlist](specs/readlist.md)
|
||||||
|
- [Feeds](specs/feeds.md)
|
||||||
|
- [Documents](specs/documents.md)
|
||||||
|
- [Omnisearch](specs/omnisearch.md)
|
||||||
|
- [Database](specs/database.md)
|
||||||
|
- [API](specs/api.md)
|
||||||
|
- [Frontend](specs/frontend.md)
|
||||||
|
- [Authentication](specs/authentication.md)
|
||||||
|
- [Emacs Integration](specs/emacs_integration.md)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under the MIT License.
|
||||||
|
|
|
||||||
50
SPECS.md
50
SPECS.md
|
|
@ -1,41 +1,49 @@
|
||||||
# QuickNotes Application Specifications
|
# QuickNotes Application Specifications
|
||||||
|
|
||||||
This document provides an overview of the QuickNotes application specifications. QuickNotes is a personal knowledge management system that allows users to create and manage notes, read later items, and RSS/Atom feeds.
|
This document provides an overview of the QuickNotes application specifications. QuickNotes is a personal knowledge management system that allows users to create and manage notes, read later items, RSS/Atom feeds, uploadable PDF documents, and perform unified full-text search across all content.
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
QuickNotes is built with a Go backend and a Svelte frontend. It uses SQLite for data storage and provides a RESTful API for communication between the frontend and backend.
|
QuickNotes is built with a Go backend and a Svelte frontend. It uses SQLite for data storage and provides a RESTful API for communication between the frontend and backend. In addition, the application includes an Emacs mode for integrated access directly from the Emacs editor.
|
||||||
|
|
||||||
## Specification Documents
|
## Specification Documents
|
||||||
|
|
||||||
The following table lists all the specification documents for the QuickNotes application:
|
The following table lists all the specification documents for the QuickNotes application:
|
||||||
|
|
||||||
| Domain | Description | Link |
|
| Domain | Description | Link |
|
||||||
|--------|-------------|------|
|
|------------------|-------------------------------------------------------------|------------------------------------------|
|
||||||
| Architecture | Overall system architecture | [Architecture](specs/architecture.md) |
|
| Architecture | Overall system architecture | [Architecture](specs/architecture.md) |
|
||||||
| Notes | Note creation, management, and linking | [Notes](specs/notes.md) |
|
| Notes | Note creation, management, and linking | [Notes](specs/notes.md) |
|
||||||
| Readlist | Read later functionality | [Readlist](specs/readlist.md) |
|
| Readlist | Save articles for later with automatic content extraction | [Readlist](specs/readlist.md) |
|
||||||
| Feeds | RSS/Atom feed management | [Feeds](specs/feeds.md) |
|
| Feeds | RSS/Atom feed subscriptions and entries | [Feeds](specs/feeds.md) |
|
||||||
| Database | Database schema and relationships | [Database](specs/database.md) |
|
| Documents | Upload and view PDF documents | [Documents](specs/documents.md) |
|
||||||
| API | API endpoints and communication | [API](specs/api.md) |
|
| Omnisearch | Full-text search across all domains | [Omnisearch](specs/omnisearch.md) |
|
||||||
| Frontend | User interface and client-side features | [Frontend](specs/frontend.md) |
|
| Database | Database schema and relationships | [Database](specs/database.md) |
|
||||||
| Authentication | User authentication (if applicable) | [Authentication](specs/authentication.md) |
|
| API | API endpoints and communication | [API](specs/api.md) |
|
||||||
| Emacs Integration | Emacs mode for QuickNotes | [Emacs Integration](specs/emacs_integration.md) |
|
| Frontend | User interface and client-side features | [Frontend](specs/frontend.md) |
|
||||||
|
| Authentication | Local-only authentication and potential future enhancements | [Authentication](specs/authentication.md) |
|
||||||
|
| Emacs Integration| Emacs mode for accessing QuickNotes features | [Emacs Integration](specs/emacs_integration.md) |
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
|
|
||||||
- Create, edit, and delete notes with Markdown support
|
- Create, edit, and delete notes with Markdown support
|
||||||
- Link notes together using wiki-style `[[note-title]]` syntax
|
- Link notes together using wiki-style syntax
|
||||||
- Visualize note connections with an interactive graph
|
- Visualize note connections with an interactive graph
|
||||||
- Save articles for later reading with automatic content extraction
|
- Save articles for later reading with automatic content extraction
|
||||||
- Manage and read RSS/Atom feeds
|
- Manage and read RSS/Atom feeds
|
||||||
- Import notes from Obsidian vaults
|
- Upload and view PDF documents directly in the app
|
||||||
- Emacs integration for accessing QuickNotes features
|
- Unified full-text search (Omnisearch) across all content
|
||||||
|
- Emacs integration for seamless workflow
|
||||||
|
|
||||||
## Technology Stack
|
## Technology Stack
|
||||||
|
|
||||||
- **Backend**: Go with Gin web framework
|
- **Backend**: Go with Gin web framework and GORM; SQLite for storage
|
||||||
- **Frontend**: Svelte with SvelteKit
|
- **Frontend**: Svelte with SvelteKit, Bulma CSS, FontAwesome
|
||||||
- **Database**: SQLite with GORM
|
- **Search Engine**: Bleve for full-text search
|
||||||
- **Package Management**: Bun (frontend), Go modules (backend)
|
- **PDF Viewing**: PDF.js-like viewer integrated in the frontend
|
||||||
- **Testing**: Go testing framework, Playwright for frontend testing
|
|
||||||
|
## Development and Deployment
|
||||||
|
|
||||||
|
- Designed for local use with potential for scalability
|
||||||
|
- Documents can be stored on local disk or blob storage (S3) in future
|
||||||
|
- Comprehensive API and Emacs mode for enhanced user interaction
|
||||||
Loading…
Add table
Reference in a new issue