A lightweight, self-hosted memo hub. Open Source and Free forever.
Go to file
2022-05-20 23:10:47 +08:00
.github/workflows fix: version getter 2022-05-17 22:19:39 +08:00
api refactor: raw struct for store 2022-05-19 18:32:04 +08:00
bin/server chore: add greeting banner 2022-05-20 22:48:36 +08:00
common fix: version getter 2022-05-17 22:19:39 +08:00
resources chore: update tech-stack.png 2022-05-15 15:44:52 +08:00
scripts refactor: backend 2022-02-03 15:32:03 +08:00
server chore: add greeting banner 2022-05-20 22:48:36 +08:00
store chore: update demo user 2022-05-20 06:48:55 +08:00
web fix: shortcutId in filter 2022-05-20 23:10:47 +08:00
.dockerignore feat: add build&push docker image action 2021-12-14 10:17:24 +08:00
.gitignore chore: add license and comments 2021-12-14 10:36:52 +08:00
CODEOWNERS chore: update readme 2022-03-06 12:07:58 +08:00
Dockerfile chore: update docker run commands 2022-03-24 20:10:46 +08:00
go.mod chore: address comments 2022-02-05 11:43:25 +08:00
go.sum chore(go): use json instead of jsonapi 2022-02-04 16:51:48 +08:00
README.md chore: update readme 2022-05-20 06:24:47 +08:00

✍️ Memos

An open source, self-hosted knowledge base that works with a SQLite db file.

GitHub stars Docker pull Go report

Live DemoDiscussions

demo

🎯 Intentions

  • ✍️ Write down the light-card memos very easily;
  • 🏗️ Build the fragmented knowledge management tool for yourself;
  • 📒 For noting your 📅 daily/weekly plans, 💡 fantastic ideas, 📕 reading thoughts...

Features

  • 🦄 Fully open source;
  • 🤠 Great UI and never miss any detail;
  • 🚀 Super quick self-hosted with Docker and SQLite;

Deploy with Docker

docker run --name memos --publish 5230:8080 --volume ~/.memos/:/var/opt/memos -e mode=prod neosmemo/memos:0.0.1

Memos should now be running at http://localhost:5230. If the ~/.memos/ does not have a memos_prod.db file, then memos will auto generate it.

🏗 Development

Memos is built with a curated tech stack. It is optimized for developer experience and is very easy to start working on the code:

  1. It has no external dependency.
  2. It requires zero config.
  3. 1 command to start backend and 1 command to start frontend, both with live reload support.

Tech Stack

tech stack

Prerequisites

  • Go (1.16 or later)
  • Air for backend live reload
  • yarn

Steps

  1. pull source code

    git clone https://github.com/justmemos/memos
    
  2. start backend using air(with live reload)

    air -c scripts/.air.toml
    
  3. start frontend dev server

    cd web && yarn && yarn dev
    

Memos should now be running at http://localhost:3000 and change either frontend or backend code would trigger live reload.

🌟 Star history

Star History Chart


Just enjoy it.