mirror of https://github.com/usememos/memos
chore: update docs
parent
b0b2776d03
commit
a0a42285d0
@ -0,0 +1,40 @@
|
|||||||
|
# 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)
|
||||||
|
- [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.
|
Loading…
Reference in New Issue