An open API service indexing awesome lists of open source software.

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: 9 months ago
JSON representation

Create and share notes quickly and easily.

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)

[![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**

https://demo.qn.me0wo.top

Only frontend preview

---

## 🚀 **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` |
|--------|--------------|

---

## 📥 **Download**

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

---

## ⚙️ **Build Instructions**

### ✅ **Using `GitHub Actions` and `goreleaser`**

Check:

* [`release.yml`](https://github.com/Sn0wo2/QuickNote/blob/main/.github/workflows/release.yml)
* [`.goreleaser.yml`](https://github.com/Sn0wo2/QuickNote/blob/main/LICENSE)

---

### 🔧 **Manual Build**

```bash
# Frontend not embedded in the binary
go build -mod=readonly -trimpath \
-tags="mysql postgres sqlite sqlserver" \
-o="QuickNote" \
-ldflags="-s -w -buildid= -extldflags=-static" \
-gcflags="all=-d=ssa/check_bce/debug=0" \
-asmflags="-trimpath" main.go

cd Frontend

bun install
bun run build

mv static/* ../

cd ../ && ./QuickNote(.exe)
```

---

## 👥 **Contributors**

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

---

## ⭐ **Star History**





Star History Chart

---

## 📄 **License**

Licensed under [GPL 3.0](LICENSE).