✍️ Memos

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

GitHub stars Docker pull Go report

Live DemoDiscuss in Telegram 👾

![demo](https://raw.githubusercontent.com/usememos/memos/main/resources/demo.webp) ## 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 docker run -d --name memos -p 5230:5230 -v ~/.memos/:/var/opt/memos neosmemo/memos:latest ``` Memos should be running at [http://localhost:5230](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](https://golang.org/doc/install) - [Air](https://github.com/cosmtrek/air#installation) for backend live reload - [Node.js](https://nodejs.org/) - [yarn](https://yarnpkg.com/getting-started/install) ### Steps 1. pull source code ```bash git clone https://github.com/usememos/memos ``` 2. start backend using air(with live reload) ```bash air -c scripts/.air.toml ``` 3. start frontend dev server ```bash cd web && yarn && yarn dev ``` Memos should now be running at [http://localhost:3000](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. 🥰 ## Star history [![Star History Chart](https://api.star-history.com/svg?repos=usememos/memos&type=Date)](https://star-history.com/#usememos/memos&Date)