From 064fbd7fbe29dc6310d9a6ceebc1ab906663810e Mon Sep 17 00:00:00 2001 From: c9s Date: Tue, 3 May 2022 12:39:35 +0800 Subject: [PATCH] doc: move frontend development setup doc --- README.md | 7 ------- doc/development/frontend.md | 40 +++++++++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+), 7 deletions(-) create mode 100644 doc/development/frontend.md diff --git a/README.md b/README.md index c0d9786b6..4ceea3cdd 100644 --- a/README.md +++ b/README.md @@ -557,13 +557,6 @@ streambook.BindStream(stream) 6. Push your changes to your fork. 7. Send a pull request. -### Setup frontend development environment - -```sh -cd frontend -yarn install -``` - ### Testing Desktop App for webview diff --git a/doc/development/frontend.md b/doc/development/frontend.md new file mode 100644 index 000000000..22f0a5447 --- /dev/null +++ b/doc/development/frontend.md @@ -0,0 +1,40 @@ +### Setup frontend development environment + +You will need yarn to install the dependencies: + +```shell +npm install -g yarn +``` + +And you need next.js: + +```shell +npm install -g next@11 +``` + +The frontend files are in the `frontend/` directory: + +```sh +cd frontend +``` + +Run `yarn install` to install the dependencies: + +```shell +yarn install +``` + +Build and compile the frontend static files: + +```shell +yarn export +``` + +To start development, use: + +```shell +yarn dev +``` + + +