Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.
Go dockerfossgomarkdownmemomicroblognote-takingnotesopen-sourceown-your-datareactself-hostedsqlitetimeline
chore: update readme
boojackd7dad057f881
diff --git a/README.md b/README.mdindex 0463c641e..8938f8e01 100644--- a/README.md+++ b/README.md@@ -1,43 +1,82 @@<h1 align="center">✍️ Memos</h1>+<p align="center">An open source, quickly self-hosted alternative to flomo</p>+<p align="center">- <a href="https://memos.onrender.com/">Live Demo</a> •- <a href="https://github.com/justmemos/memos/discussions">Discussions</a>+ <img alt="GitHub stars" src="https://img.shields.io/github/stars/justmemos/memos" />+ <img alt="Docker pull" src="https://img.shields.io/docker/pulls/neosmemo/memos.svg" />+ <img alt="Go report" src="https://goreportcard.com/badge/github.com/justmemos/memos" /></p><p align="center">- <img alt="GitHub stars" src="https://img.shields.io/github/stars/justmemos/memos" />- <img alt="GitHub forks" src="https://img.shields.io/github/forks/justmemos/memos" />- <img alt="GitHub Watchers" src="https://img.shields.io/github/watchers/justmemos/memos" />+ <a href="https://memos.onrender.com/">Live Demo</a> •+ <a href="https://github.com/justmemos/memos/discussions">Discussions</a></p>-Memos is an open source, self-hosted alternative to [flomo](https://flomoapp.com/). Built with `Go` and `React`.--Making sure that you are in charge of your data and more customizations.+Built with `Go`, `SQLite` and `React`.## 🎯 Intentions-- ✍️ For noting 📅 daily/weekly plans, 💡 fantastic ideas, 📕 reading thoughts...-- 📒 Write down the lightweight card memos easily;-- 🏗️ Build your own fragmented knowledge management tools;+- ✍️ 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;-- 😋 Beautiful and detailed visual styles;-- 📑 Experience excellent interaction logic;-- ⚡️ Quick privatization deployment;+- 🤠 Great UI and never miss any detail;+- 🚀 Super quick self-hosted with `Docker` and `SQLite`;## ⚓️ Deploy with Docker```docker-docker run --name memos --publish 8080:8080 --volume ~/path/to/your/data/:/var/opt/memos -e mode=prod neosmemo/memos:dev+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++++### Prerequisites++- [Go](https://golang.org/doc/install) (1.16 or later)+- [Air](https://github.com/cosmtrek/air#installation) for backend live reload+- [yarn](https://yarnpkg.com/getting-started/install)++### Steps++1. pull source code++ ```bash+ git clone https://github.com/justmemos/memos+ ```++2. start backend using air(with live reload)++ ```bash+ air -c scripts/.air.toml+ ```++3. start frontend dev server++ ```bash+ 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[](https://star-history.com/#justmemos/memos&Date)diff --git a/resources/tech-stack.png b/resources/tech-stack.pngnew file mode 100644index 000000000..4cd8113d5Binary files /dev/null and b/resources/tech-stack.png differ