From e9b13f263842e4159d55452d3e9de44d23d2978b Mon Sep 17 00:00:00 2001 From: Falk Wolsky Date: Fri, 20 Oct 2023 13:43:53 +0200 Subject: [PATCH 1/2] Update README.md Just added new Documentation Link --- client/README.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/client/README.md b/client/README.md index 0130a7c73..cce00496f 100644 --- a/client/README.md +++ b/client/README.md @@ -6,18 +6,18 @@ #### Use prebuilt docker image -Simply run below command to start a backend server. +Simply run the below command to start a backend server. ```bash docker run -d --name lowcoder -p 3000:3000 -v "$PWD/stacks:/lowcoder-stacks" lowcoderorg/lowcoder-ce ``` -For more information, view our [docs](../docs/self-hosting) +For more information, view our [docs](https://docs.lowcoder.cloud/lowcoder-documentation/setup-and-run/self-hosting) #### Build Docker image from source -1. Check out source code and change to source dir. -2. Use the command below to build Docker image : +1. Check out the source code and change to source dir. +2. Use the command below to build a Docker image : ```bash docker build -f ./deploy/docker/Dockerfile -t lowcoder-dev . @@ -31,11 +31,21 @@ docker run -d --name lowcoder-dev -p 3000:3000 -v "$PWD/stacks:/lowcoder-stacks" ### Start develop -1. Check out source code. +1. Check out the source code. 2. Change to client dir in the repository root via cd client. -3. Run yarn to install dependencies: . -4. Start dev server: `LOWCODER_API_SERVICE_URL=http://localhost:3000 yarn start`. -5. After dev server starts successfully, it will be automatically opened in the default browser. + +```bash +cd client +```bash + +4. Run yarn to install dependencies: . + +```bash +yarn install +```bash + +5. Start dev server: `LOWCODER_API_SERVICE_URL=http://localhost:3000 yarn start`. +6. After the dev server starts successfully, it will be automatically opened in the default browser. ### Before submitting a pull request From 7154d99b1d430ba1f8e6ce6d326471086be61b57 Mon Sep 17 00:00:00 2001 From: Falk Wolsky Date: Fri, 20 Oct 2023 13:44:30 +0200 Subject: [PATCH 2/2] Update README.md Fixed styling --- client/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/README.md b/client/README.md index cce00496f..3f504a8ee 100644 --- a/client/README.md +++ b/client/README.md @@ -36,13 +36,13 @@ docker run -d --name lowcoder-dev -p 3000:3000 -v "$PWD/stacks:/lowcoder-stacks" ```bash cd client -```bash +``` 4. Run yarn to install dependencies: . ```bash yarn install -```bash +``` 5. Start dev server: `LOWCODER_API_SERVICE_URL=http://localhost:3000 yarn start`. 6. After the dev server starts successfully, it will be automatically opened in the default browser.