Skip to content
/ memos Public
forked from usememos/memos

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

Notifications You must be signed in to change notification settings

yyysuo/memos

 
 

Repository files navigation

✍️ 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.1.0

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/usememos/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.

About

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

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 56.2%
  • Go 26.4%
  • Less 16.7%
  • JavaScript 0.3%
  • Dockerfile 0.2%
  • HTML 0.2%