usememos/memos
1
1
Fork 0
mirror of https://github.com/usememos/memos.git synced 2024-12-19 09:02:49 +03:00
Code Issues Packages Projects Releases Wiki Activity
A lightweight, self-hosted memo hub. Open Source and Free forever.
219 Commits 1 Branch 73 Tags 82 MiB
Go 53.2%
TypeScript 46.2%
Less 0.3%
JavaScript 0.1%
HTML 0.1%
e202d7b8d6
Go to file
Hyoban e202d7b8d6
fix: banner text click not work (#104) 
* fix: banner text click not work

* fix: replenish duration

Co-authored-by: boojack <stevenlgtm@gmail.com>

Co-authored-by: boojack <stevenlgtm@gmail.com>
2022-07-06 11:22:19 +08:00
.github/workflows chore: update github action 2022-07-04 22:37:31 +08:00
api chore: rename module 2022-06-27 22:09:06 +08:00
bin/server chore: rename module 2022-06-27 22:09:06 +08:00
common feat: schema migration handler (#100) 2022-07-02 10:47:16 +08:00
resources chore: update demo.png 2022-07-03 11:34:04 +08:00
scripts refactor: backend 2022-02-03 15:32:03 +08:00
server feat: use api with open_id instead of webhooks 2022-07-05 22:04:17 +08:00
store fix: patch memo missing creator_id 2022-07-04 21:27:44 +08:00
web fix: banner text click not work (#104) 2022-07-06 11:22:19 +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 fix: dockerfile 2022-07-03 22:45:10 +08:00
go.mod chore: rename module 2022-06-27 22:09:06 +08:00
go.sum chore(go): use json instead of jsonapi 2022-02-04 16:51:48 +08:00
LICENSE feat: responsive view (#75) 2022-06-19 11:32:49 +08:00
README.md chore: release v0.1.3 (#98) 2022-07-01 20:39:48 +08:00

README.md

✍️ Memos

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

GitHub stars Docker pull Go report

Live Demo • Discussions

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;
  • 👍 Write in the plain textarea without any burden;
  • 🤠 Great UI and never miss any detail;
  • 🚀 Super quick self-hosted with Docker and SQLite;

⚓️ Deploy with Docker

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

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.