https://github.com/notepia/notepia
Notepia is an open-source, self-hosted pinboard service designed to help you organize links, notes, and resources in a flexible and visual way.
https://github.com/notepia/notepia
calendar collaboration file-management flow location-tracker map memos note-taking pin pinboard pins real-time rss-reader self-hosted todolist view whiteboard widget
Last synced: 5 months ago
JSON representation
Notepia is an open-source, self-hosted pinboard service designed to help you organize links, notes, and resources in a flexible and visual way.
- Host: GitHub
- URL: https://github.com/notepia/notepia
- Owner: notepia
- Created: 2025-09-01T11:03:14.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2026-01-19T15:19:37.000Z (5 months ago)
- Last Synced: 2026-01-19T21:56:40.796Z (5 months ago)
- Topics: calendar, collaboration, file-management, flow, location-tracker, map, memos, note-taking, pin, pinboard, pins, real-time, rss-reader, self-hosted, todolist, view, whiteboard, widget
- Language: TypeScript
- Homepage:
- Size: 4.11 MB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Notepia
**Notepia** is an open-source, self-hosted pinboard service designed to help you organize links, notes, and resources in a flexible and visual way.
Build your own workspace with widgets, keep everything in one place, and stay in full control of your data.
## ✨ Features
* 🧩 **10+ Built-in Widgets**
Choose from more than 10 different widgets, including link, note, carousel, rss reader, map, calendar, folder, and more.
* 🗂️ **Unlimited Workspaces**
Create unlimited workspaces to organize content by projects, topics, or personal needs.
* 📌 **Flexible Pinboard Layout**
Arrange and customize widgets freely within each workspace.
* 🗓️ **Calendar View**
Visualize pins and content in a calendar-based view for better time-based organization.
* 🗺️ **Map View**
View location-based pins on an interactive map, perfect for travel plans or geo-related notes.
* 📋 **Kanban Board**
Organize tasks with a powerful kanban board supporting drag-and-drop, multiple columns, and task management.
* 🔄 **Flow Diagram**
Create and edit visual flowcharts and diagrams with an intuitive node-based editor.
* 🎨 **Collaborative Whiteboard**
Real-time collaborative whiteboard for brainstorming, sketching, and visual planning with your team.
* ✍️ **Real-time Collaborative Notes**
Edit notes together in real-time with CRDT-based synchronization powered by Y.js, ensuring conflict-free collaboration.
* 🌐 **Modern Web Interface**
Clean, responsive UI optimized for both desktop and mobile devices.
* 🏠 **Fully Self-Hosted**
Deploy Notepia on your own server and keep full ownership of your data.
* 🧾 **Open Source**
Transparent, extensible, and community-driven.
* 🐳 **Docker Ready**
Simple deployment with Docker and Docker Compose.
---
## 🚀 Installation
### Docker Compose (Recommended)
Notepia is available on Docker Hub as a single image that can run both the web service and background worker.
For production use with background job processing and real-time collaboration features:
```yaml
services:
redis:
image: redis:7-alpine
container_name: notepia-redis
restart: unless-stopped
volumes:
- redis_data:/data
command: redis-server --appendonly yes
healthcheck:
test: ["CMD", "redis-cli", "ping"]
interval: 10s
timeout: 5s
retries: 5
web:
image: notepia/notepia
container_name: notepia-web
command: ["./web"]
ports:
- "8080:8080"
volumes:
- notepia_data:/usr/local/app/bin
environment:
REDIS_ADDR: redis:6379
depends_on:
redis:
condition: service_healthy
restart: unless-stopped
worker:
image: notepia/notepia
container_name: notepia-worker
command: ["./worker"]
volumes:
- notepia_data:/usr/local/app/bin
environment:
REDIS_ADDR: redis:6379
depends_on:
redis:
condition: service_healthy
restart: unless-stopped
volumes:
redis_data:
driver: local
notepia_data:
driver: local
```
Start the services:
```bash
docker compose up -d
```
## 🤝 Contributing
Contributions are welcome!
* Fork the repository
* Create your feature branch
* Commit your changes
* Open a pull request
---
## 📄 License
Notepia is licensed under the **MIT License**.
---