README.md

QuickNote

Create and share notes quickly and easily.

---

🎉 Demo

🔗 Preview (Release Version): https://note.me0wo.top
如果你在中国大陆，可以使用这个加速CDN访问：https://qnote.me0wo.top
✨ Full features available (updated manually, may be slightly delayed)

We’re working on enabling automatic deployment for this preview demo.

🛠 Vercel (Build Preview): https://demo.qn.me0wo.top
🚧 Frontend-only preview — saving is not supported

---

📦 Docker (RECOMMEND)

docker pull me0wo/quicknote
docker compose up -d

• DockerHub

• docker-compose.yml

---

📥 Download

---

🚀 Project Status

Status	Developing

---

✅ Features

• ✔️ No login required
• ✔️ High performance
• ✔️ Simple UI
• ✔️ Markdown preview support
• ✔️ Dark Mode
• ✔️ Note sharing
• ️️✔️ Compression

Planned:

• 🔒 Encryption
• 🕑 Note history

---

🗃️ Supported Databases

• Relational:

  • MySQL, MariaDB, TiDB, Aurora
  • PostgreSQL, CockroachDB, AlloyDB
  • SQLite3
  • Microsoft SQL Server

---

📚 Docs

Status	Developing

---

⚙️ Build Instructions

✅ Using GitHub Actions and goreleaser (RECOMMEND)

Check:

• release.yml
• .goreleaser.yml
• Dockerfile

---

🔧 Manual Build

Requires:

• Go SDK latest version
• Node.js latest version
• pnpm latest version
• GoReleaser latest version

Check:

• Makefile
• .goreleaser.yml
• Dockerfile

Run:

make test_release

---

👥 Contributors

---

⭐ Star History

---

📄 License

Licensed under GPL 3.0.