Web Getting Started

Run the web client locally

Shared Setup

Before starting either client, finish the common workspace setup first:

Install Prerequisites

Ensure your development environment has the necessary tools installed:

Install Node.js 20+
Install pnpm 9+
Install git

Clone Repository

Clone the repository and enter the project root to begin development:

# clone repository
git clone https://github.com/sunshineLixun/easystarter.git your-project-name

# enter project root
cd your-project-name

# remove default origin
git remote remove origin

# add your own origin
git remote add origin https://github.com/your-username/your-project-name.git

# push to origin
git push -u origin main

Install Dependencies

Run the following command to download and install all necessary project dependencies:

pnpm install

Launch Local Services

Start the development client:

pnpm dev:web

Default local development URL:

Web: http://localhost:3000
Server: http://localhost:3001

Introduction

EasyStarter documentation entry point, quickly understand project structure, core capabilities, and common guides

Project Structure

Understand the monorepo directory organization of easystarter

On this page

Launch Local Services