From 4cf26d085a9e156636daac6444857d2962c4ac97 Mon Sep 17 00:00:00 2001 From: Boming Zhang Date: Fri, 2 Feb 2024 20:27:16 -0500 Subject: [PATCH] docs: update README --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 3c7e321..f69b02a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ # React + TypeScript + Vite +## Quick Start + +- Install `Mode.js` and `pnpm` +- Run `pnpm install` to install dependencies +- Run `pnpm dev` to start the development server +- Visit `http://localhost:5173` to see the app +- The app will automatically reload if you change any of the source files +- When you have changed the API in the backend and started the backend server, run `pnpm gen:api` to regenerate the API client + This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. Currently, two official plugins are available: