memos/docs/development.md
2025-01-19 10:46:35 +08:00

1,007 B

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 the source code

    git clone https://github.com/usememos/memos
    
  2. Build and run backend server

    sh scripts/build.sh
    

    Then you can run the server following building outputs.

  3. Install frontend dependencies and generate TypeScript code from protobuf

    cd web && pnpm i
    
  4. Start the dev server of frontend

    cd web && pnpm dev
    

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