development.md 1.0 KB

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.

Prerequisites

Steps

  1. pull source code

    git clone https://github.com/usememos/memos
    
  2. start backend using air(with live reload)

    air -c scripts/.air.toml
    
  3. generate TypeScript code from protobuf with buf

    cd proto && buf generate
    
  4. start frontend dev server

    cd web && pnpm i && pnpm dev
    

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