An open source, lightweight note-taking service. Easily capture and share your great thoughts.
Find a file
2022-05-15 10:56:32 +08:00
.github/workflows chore: update dev image tag name 2022-03-29 21:09:55 +08:00
api update: seed data 2022-05-03 11:49:10 +08:00
bin/server feat: system api with profiles 2022-03-29 20:53:43 +08:00
common chore: update mode flag 2022-05-02 09:40:25 +08:00
resources chore: update readme 2022-05-15 10:54:00 +08:00
scripts
server chore: typo Id to ID 2022-05-03 02:05:43 +08:00
store update: seed data 2022-05-03 11:49:10 +08:00
web chore: fix link style 2022-05-08 23:17:11 +08:00
.dockerignore
.gitignore
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
go.sum
README.md chore: update readme 2022-05-15 10:56:32 +08:00

✍️ Memos

An open source, quickly self-hosted alternative to flomo

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 8080:8080 --volume /path/to/your/data/:/var/opt/memos -e mode=prod neosmemo/memos:dev

If the /path/to/your/data doesn't have a memos_prod.db file, then memos will auto-generate it and the default username is dear_musk with password secret.

🏗 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 frontend && yarn && yarn dev
    

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

🌟 Star history

Star History Chart


Just enjoy it.