mirror of
https://github.com/usememos/memos.git
synced 2024-09-21 23:05:59 +08:00
99 lines
3.1 KiB
Markdown
99 lines
3.1 KiB
Markdown
<p align="center"><a href="https://usememos.com"><img height="64px" src="https://raw.githubusercontent.com/usememos/memos/main/resources/logo-full.webp" alt="✍️ memos" /></a></p>
|
|
|
|
<p align="center">An open source, self-hosted knowledge base that works with a SQLite db file.</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/usememos/memos/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/usememos/memos" /></a>
|
|
<a href="https://hub.docker.com/r/neosmemo/memos"><img alt="Docker pull" src="https://img.shields.io/docker/pulls/neosmemo/memos.svg" /></a>
|
|
<img alt="Go report" src="https://goreportcard.com/badge/github.com/usememos/memos" />
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://demo.usememos.com/">Live Demo</a> •
|
|
<a href="https://t.me/+-_tNF1k70UU4ZTc9">Discuss in Telegram 👾</a>
|
|
</p>
|
|
|
|
|
|
|
|
## 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
|
|
docker run -d --name memos -p 5230:5230 -v ~/.memos/:/var/opt/memos neosmemo/memos:latest
|
|
```
|
|
|
|
#### Docker Compose
|
|
|
|
```
|
|
version: "3.0"
|
|
services:
|
|
memos:
|
|
image: neosmemo/memos:latest
|
|
container_name: memos
|
|
volumes:
|
|
- ~/.memos/:/var/opt/memos
|
|
ports:
|
|
- 5230:5230
|
|
```
|
|
|
|
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
|
|
|
|
<img alt="tech stack" src="https://raw.githubusercontent.com/usememos/memos/main/resources/tech-stack.png" width="360" />
|
|
|
|
### 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
|
|
|
|
[](https://star-history.com/#usememos/memos&Date)
|