usememos/memos
1
1
Fork 0
mirror of https://github.com/usememos/memos.git synced 2024-11-11 01:12:40 +08:00
Code Issues Projects Releases Packages Wiki Activity
memos/docs/development.md
Leyang be2db3f170
feat: use vite plugin pwa for generate right sw.js (#2658) 
Co-authored-by: boojack <stevenlgtm@gmail.com>
2023-12-23 12:00:03 +08:00

1.1 KiB
Raw Blame History

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. 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 && pnpm type-gen

  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.