OpenFlomo

An open source Flomo, help you quickly record memos.

Features

🦄 Fully open source;
📜 Writing in plain textarea without any burden,
- and support some useful markdown syntax 💪.
🌄 Share the memo in a pretty image or personal page like Twitter;
🚀 Fast self-hosting with Docker;
🤠 Pleasant UI and UX;

Deploy with Docker

Docker Run

docker run -d --name open-flomo --publish 8080:8080 --volume ~/.open-flomo/:/var/opt/open-flomo zdeteam/open-flomo:latest --mode prod --port 8080 --emailHost 发送邮件服务器(例如：smtp.exmail.qq.com) --emailPort 端口号 --emailUsername 邮箱账号 --emailPassword 邮箱密码

OpenFlomo should be running at http://localhost:5230. If the ~/.memos/ does not have a memos_prod.db file, then memos will auto generate it.

Docker Compose

See the example docker-compose.yaml file.

Development

OpenFlomo is built with a curated tech stack. It is optimized for developer experience and is very easy to start working on the code:

It has no external dependency.
It requires zero config.
1 command to start backend and 1 command to start frontend, both with live reload support.

Prerequisites

Go
Air for backend live reload
Node.js
yarn

Steps

pull source code

git clone https://github.com/zdeteam/open-flomo.git

start backend using air(with live reload)
```
air -c scripts/.air.toml
```
start frontend dev server
```
cd web && yarn && yarn dev
```

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

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. 🥰