docs: update README.md (#1327)

This commit is contained in:
Himself65
2023-03-05 12:18:56 -06:00
committed by GitHub
parent 3a55f5f798
commit e8dc9809e2
2 changed files with 36 additions and 3 deletions

View File

@@ -1,10 +1,10 @@
# Building AFFiNE
# Building AFFiNE Web
## Table of Contents
- [Prerequisites](#prerequisites)
- [Setup Environment](#setup-environment)
- [Play with Playground](#play-with-playground)
- [Start Development Server](#start-development-server)
- [Testing](#testing)
## Prerequisites
@@ -33,7 +33,7 @@ nvm use --lts
pnpm install
```
## Play with Playground
## Start Development Server
```sh
pnpm dev
@@ -41,6 +41,8 @@ pnpm dev
The playground page should work at [http://localhost:8080/](http://localhost:8080/)
For more details, see [apps/web/README.md](../apps/web/README.md)
## Testing
Adding test cases is strongly encouraged when you contribute new features and bug fixes.