https://github.com/sn0wo2/quicknote

Create and share notes quickly and easily.
https://github.com/sn0wo2/quicknote

backend go golang markdown mysql note postgresql quicknote sqlite sqlite3 sqlserver

Last synced: 17 days ago
JSON representation

Create and share notes quickly and easily.

• Host: GitHub
• URL: https://github.com/sn0wo2/quicknote
• Owner: Sn0wo2
• License: gpl-3.0
• Created: 2025-06-02T20:28:31.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2025-06-22T13:20:14.000Z (10 months ago)
• Last Synced: 2025-06-22T13:41:43.519Z (10 months ago)
• Topics: backend, go, golang, markdown, mysql, note, postgresql, quicknote, sqlite, sqlite3, sqlserver
• Language: Go
• Homepage:
• Size: 1.51 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  

  QuickNote



> Create and share notes quickly and easily.

[![GitHub License](https://img.shields.io/github/license/Sn0wo2/QuickNote)](LICENSE)

![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/Sn0wo2/QuickNote/total)

![Docker Pulls](https://img.shields.io/docker/pulls/me0wo/quicknote)

![Docker Stars](https://img.shields.io/docker/stars/me0wo/quicknote)

![Docker Image Size](https://img.shields.io/docker/image-size/me0wo/quicknote)

[![CodeQL](https://github.com/Sn0wo2/QuickNote/actions/workflows/codeql.yml/badge.svg)](https://github.com/Sn0wo2/QuickNote/actions/workflows/codeql.yml)

[![Dependabot Updates](https://github.com/Sn0wo2/QuickNote/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/Sn0wo2/QuickNote/actions/workflows/dependabot/dependabot-updates)

[![Go CI](https://github.com/Sn0wo2/QuickNote/actions/workflows/go.yml/badge.svg)](https://github.com/Sn0wo2/QuickNote/actions/workflows/go.yml)

[![React CI](https://github.com/Sn0wo2/QuickNote/actions/workflows/react.yml/badge.svg)](https://github.com/Sn0wo2/QuickNote/actions/workflows/react.yml)

[![Release](https://github.com/Sn0wo2/QuickNote/actions/workflows/release.yml/badge.svg)](https://github.com/Sn0wo2/QuickNote/actions/workflows/release.yml)

---

## 🎉 **Demo**

**🔗 Preview (Release Version):** [https://note.me0wo.top](https://note.me0wo.top)  

如果你在中国大陆，可以使用这个加速CDN访问：[https://qnote.me0wo.top](https://qnote.me0wo.top)  

*✨ Full features available (updated manually, may be slightly delayed)*

> We’re working on enabling [**automatic deployment**](https://github.com/Sn0wo2/QuickNote/tree/main/Updater) for this preview demo.

**🛠 Vercel (Build Preview):** [https://demo.qn.me0wo.top](https://demo.qn.me0wo.top)  

*🚧 Frontend-only preview — saving is not supported*

---

## 📦 **Docker** (RECOMMEND)

```bash

docker pull me0wo/quicknote

docker compose up -d

```

* [DockerHub](https://hub.docker.com/r/me0wo/quicknote)

* [docker-compose.yml](docker-compose.yml)

---

## 📥 **Download**

[![GitHub release](https://img.shields.io/github/v/release/Sn0wo2/QuickNote?logo=github)](https://github.com/Sn0wo2/QuickNote/releases)

---

## 🚀 **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`](.github/workflows/release.yml)

* [`.goreleaser.yml`](LICENSE)

* [`Dockerfile`](Dockerfile)

---

### 🔧 **Manual Build**

Requires:

* [`Go SDK`](https://go.dev/dl) latest version

* [`Node.js`](https://nodejs.org/zh-cn/download) latest version

* [`pnpm`](https://pnpm.io/installation) latest version

* [`GoReleaser`](https://github.com/goreleaser/goreleaser/releases) latest version

Check:

* [`Makefile`](Makefile)

* [`.goreleaser.yml`](LICENSE)

* [`Dockerfile`](Dockerfile)

> Run:

> ```bash

> make test_release

> ```

---

## 👥 **Contributors**

![Contributors](https://contrib.rocks/image?repo=Sn0wo2/QuickNote)

---

## ⭐ **Star History**



 

   

   

   

 



---

## 📄 **License**

Licensed under [GPL 3.0](LICENSE).