memos/README.md

48 lines
1.6 KiB
Markdown
Raw Normal View History

2022-01-17 08:42:36 +08:00
<h1 align="center">✍️ Memos</h1>
<p align="center">
2022-01-17 08:42:36 +08:00
<a href="https://memos.onrender.com/">Live Demo</a>
2022-02-04 22:00:13 +08:00
<a href="https://github.com/justmemos/memos/discussions">Discussions</a>
</p>
2022-01-17 08:42:36 +08:00
<p align="center">
2022-01-17 08:42:36 +08:00
<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" />
</p>
2021-12-08 23:43:14 +08:00
![demo](https://raw.githubusercontent.com/justmemos/memos/main/resources/demo.webp)
2022-03-06 12:07:58 +08:00
Memos is an open source, self-hosted alternative to [flomo](https://flomoapp.com/). Built with `Go` and `React`.
2022-02-04 22:00:13 +08:00
Making sure that you are in charge of your data and more customizations.
2022-02-04 22:00:13 +08:00
## 🎯 Intentions
2022-02-04 22:00:13 +08:00
- ✍️ For noting 📅 daily/weekly plans, 💡 fantastic ideas, 📕 reading thoughts...
- 📒 Write down the lightweight card memos easily;
- 🏗️ Build your own fragmented knowledge management tools;
2022-01-17 08:42:36 +08:00
2022-02-04 22:00:13 +08:00
## ✨ Features
2022-03-06 12:07:58 +08:00
- 🦄 Fully open source;
2022-02-04 22:00:13 +08:00
- 😋 Beautiful and detailed visual styles;
- 📑 Experience excellent interaction logic;
- ⚡️ Quick privatization deployment;
2022-05-01 11:06:29 +08:00
## ⚓️ Deploy with Docker
2022-04-03 21:54:54 +08:00
2022-05-01 11:06:29 +08:00
```docker
2022-05-02 09:40:38 +08:00
docker run --name memos --publish 8080:8080 --volume ~/path/to/your/data/:/var/opt/memos -e mode=prod neosmemo/memos:dev
2022-05-01 11:06:29 +08:00
```
2022-04-03 21:54:54 +08:00
2022-05-02 09:40:38 +08:00
If the `/path/to/your/data` doesn't have a `.db` file, then memos will auto-generate it and the default username is `guest` with password `secret`.
2022-04-03 21:54:54 +08:00
2022-04-03 22:14:43 +08:00
## 🌟 Star history
[![Star History Chart](https://api.star-history.com/svg?repos=justmemos/memos&type=Date)](https://star-history.com/#justmemos/memos&Date)
2022-02-04 22:00:13 +08:00
---
Just enjoy it.