memos/docs/development.md

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

• Go
• Air for backend live reload
• Node.js
• pnpm

Steps

1. Pull the source code

   git clone https://github.com/usememos/memos
   

2. Start backend server with air (with live reload)

   air -c scripts/.air.toml
   

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.