Skip to content

OpenDocky/DockyNotes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

5 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ“ DockyNotes

Simple, Fast, and Free Note-Taking for Everyone

The modern alternative to Notion and Obsidian - 100% web-based, 100% free, 100% open source

๐Ÿš€ Try DockyNotes โ€ข ๐Ÿ“– Documentation โ€ข ๐Ÿ› Report Bug โ€ข โœจ Request Feature

Version License TypeScript Next.js


โœจ Why DockyNotes?

In a world of bloated note-taking apps with paywalls and complexity, DockyNotes offers a breath of fresh air.

  • ๐Ÿš€ Lightning Fast - No loading screens, instant sync, smooth performance
  • ๐ŸŽจ Clean & Simple - Beautiful UI without the clutter
  • ๐Ÿ“ฑ Web-First - Access anywhere, any device, just open your browser
  • ๐Ÿ”„ Real-time Sync - Your notes, always up-to-date across all devices
  • ๐ŸŽฏ Markdown Native - Write in markdown with live preview
  • ๐Ÿ†“ 100% Free - No premium tiers, no paywalls, forever
  • ๐Ÿ”“ Open Source - Community-driven, transparent, yours to customize

๐ŸŽฏ Features

Current (V1.0)

โœ๏ธ Powerful Editor

  • Full markdown support with live preview
  • Syntax highlighting for code blocks
  • WYSIWYG and raw markdown modes
  • Auto-save (never lose your work)
  • Keyboard shortcuts for power users

๐Ÿ“ Smart Organization

  • Nested folders and workspaces
  • Tag system for easy categorization
  • Instant search across all notes
  • Favorites/starred notes
  • Drag-and-drop organization

๐Ÿ”„ Seamless Sync

  • Real-time synchronization
  • Cross-device support
  • Offline mode (coming soon)
  • Conflict resolution

๐Ÿ“ค Export Options

  • Export to Markdown (.md)
  • Export to PDF
  • Export to HTML
  • Bulk export

๐Ÿ” Secure & Private

  • Secure authentication
  • Your data is encrypted
  • Privacy-first approach
  • Optional public sharing

Coming Soon (V2.0+)

  • ๐Ÿค Collaborative editing - Work together in real-time
  • ๐Ÿ–ผ๏ธ Rich media support - Embed images, videos, and files
  • ๐Ÿ“‹ Templates - Start from pre-made note structures
  • ๐Ÿ“Š Tables & databases - Organize data visually
  • ๐ŸŽจ Themes & customization - Make it yours
  • โšก API access - Integrate with your workflow
  • ๐Ÿ“œ Version history - Never lose a previous version
  • ๐ŸŒ Public notes - Share your notes with the world

๐Ÿš€ Getting Started

For Users

  1. Visit dockynotes.drayko.xyz
  2. Sign up with Google or Email
  3. Start writing!

That's it. No apps to install, no configuration needed.

For Developers

# Clone the repository
git clone https://github.com/OpenDocky/DockyNotes.git

# Navigate to the project directory
cd DockyNotes

# Install dependencies
npm install

# Set up environment variables
cp .env.example .env.local
# Add your configuration to .env.local

# Run the development server
npm run dev

Visit http://localhost:3000 to see your local instance.

๐Ÿ—๏ธ Tech Stack

  • Framework: Next.js 15
  • Language: TypeScript
  • Editor: TipTap / Lexical
  • Database: Neon (PostgreSQL)
  • Authentication: Clerk
  • Styling: Tailwind CSS
  • Deployment: Vercel

๐Ÿ“– Documentation

Basic Usage

Creating a Note:

  1. Click "New Note" or press Ctrl/Cmd + N
  2. Start writing in markdown
  3. Your note auto-saves as you type

Organizing Notes:

  • Create folders by clicking "New Folder"
  • Drag notes into folders
  • Add tags with #tagname
  • Star important notes

Keyboard Shortcuts:

  • Ctrl/Cmd + N - New note
  • Ctrl/Cmd + S - Manual save
  • Ctrl/Cmd + F - Search
  • Ctrl/Cmd + K - Command palette
  • Ctrl/Cmd + / - Toggle markdown/preview

Markdown Support

DockyNotes supports full GitHub-flavored markdown:

# Headers
## Subheaders

**Bold** and *italic* text

- Bullet lists
1. Numbered lists

[Links](https://example.com)

`Inline code` and code blocks:

```javascript
function hello() {
  console.log("Hello, DockyNotes!");
}```

> Blockquotes

Tables, checkboxes, and more!

๐Ÿค Contributing

We love contributions! DockyNotes is community-driven and we welcome:

  • ๐Ÿ› Bug reports
  • โœจ Feature requests
  • ๐Ÿ“– Documentation improvements
  • ๐Ÿ”ง Code contributions

How to Contribute

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Please read our Contributing Guidelines before submitting PRs.

๐Ÿ—บ๏ธ Roadmap

Phase 1 - MVP โœ… (Current)

  • Basic markdown editor
  • Folders and organization
  • Real-time sync
  • Authentication
  • Export functionality

Phase 2 - Enhanced Features ๐Ÿšง (In Progress)

  • Dark mode
  • Advanced search
  • Templates
  • Rich media embeds

Phase 3 - Collaboration ๐Ÿ“… (Planned)

  • Real-time collaboration
  • Shared workspaces
  • Comments and discussions

Phase 4 - Advanced ๐Ÿ”ฎ (Future)

  • API access
  • Mobile apps
  • Offline-first architecture
  • End-to-end encryption

๐ŸŒŸ Why Open Source?

We believe note-taking is fundamental to productivity and learning. It shouldn't be locked behind paywalls or proprietary software.

DockyNotes is:

  • Free to use, forever
  • Transparent in its operation
  • Community-owned and driven
  • Privacy-respecting by design

๐Ÿ’ก Use Cases

  • ๐Ÿ“š Students - Take lecture notes, organize research
  • ๐Ÿ’ผ Professionals - Meeting notes, project documentation
  • โœ๏ธ Writers - Draft articles, organize ideas
  • ๐Ÿ’ป Developers - Code snippets, technical documentation
  • ๐ŸŽจ Creators - Brainstorming, content planning
  • ๐Ÿ“– Researchers - Literature reviews, citation management

๐Ÿ”’ Privacy & Security

  • Your notes are encrypted in transit and at rest
  • We never sell your data
  • No tracking beyond basic analytics
  • You can export and delete all your data anytime
  • Open source means full transparency

๐Ÿ“Š Comparison

Feature DockyNotes Notion Obsidian Apple Notes
Price Free Freemium Freemium Free*
Web Access โœ… โœ… โŒ โŒ
Open Source โœ… โŒ โŒ โŒ
Real-time Sync โœ… Free โœ… โœ… Paid โœ… Apple only
Markdown โœ… Native โš ๏ธ Limited โœ… Native โŒ
Speed โšก Fast ๐ŸŒ Slow โšก Fast โšก Fast
Offline ๐Ÿ”œ Soon โœ… โœ… โœ…

*Apple Notes free but requires Apple ecosystem

๐Ÿ’ฌ Community

  • GitHub Discussions: Share ideas and get help

๐Ÿ“ License

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

๐Ÿ™ Acknowledgments

Built with amazing open source tools:

โญ Star History

If you find DockyNotes useful, please consider giving it a star!

Star History Chart


Built with โค๏ธ by Drayko

Part of the OpenDocky suite of tools

DockyAI โ€ข DockyCalendar โ€ข DockyStatus โ€ข DockyNotes

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published