cadamsdev / notes

An open-source note taking app for developers

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Notes

contributions welcome

Note: This app is in early alpha. Expect breaking changes and bugs.

Screenshot_8-6-2024_135854_chad lan

Why another note app?

For taking technical notes I wanted a note taking app that has...

  • Simple like Apple notes (but has code syntax highlighting)
  • Block-based editor like Notion
  • Works offline (Like Obsidian)
  • Uses tags instead of a folder structure
    • Don't have to worry about categorizing your notes in a hierarchy, just create the note.
    • To categorize the notes add a tag (Also will help you find it)
  • Works on Windows, Linux or Mac
  • Self hostable
  • Privacy respecting (no telemetry, no selling data)
  • Secure
  • Highly configurable
  • Free and open-source

Roadmap

  • Search by tags (Improved search)
  • More blocks
  • Light mode (currently only dark mode)
  • Settings page
  • AI Integration
  • Password protected notes
  • Graph view (like Obsidian)
  • Plugins (Extensible)
  • Desktop app
  • Mobile app
  • Support more architectures

Supported architectures

Architecture Support
x86-64 (AMD64)
ARM64
x86 (32-bit)

Current Features

  • Self-hostable
  • Create notes
  • Edit notes
  • Search notes
  • Add tags to notes
  • Edit tags (tag name, color)
  • Delete tags
  • Block editor
    • Headings (h1, h2, h3)
    • Paragraphs
    • Bulleted list
    • Numbered lists
    • Inline code
    • Code blocks
    • Divider
    • Quote

Local development

  1. Npm install
npm install
  1. Start web-app
npm run web:dev
  1. Navigate to http://localhost:5173/

Self hosting with Docker

  1. Pull docker image
docker pull cadamsdev/notes:latest
  1. Run docker container
docker run -d -p 4173:4173 -v ~/.notes:/app/data --name notes cadamsdev/notes

About

An open-source note taking app for developers

License:GNU General Public License v3.0


Languages

Language:Svelte 42.2%Language:TypeScript 40.9%Language:CSS 9.3%Language:JavaScript 6.4%Language:Dockerfile 0.8%Language:HTML 0.4%