Skip to content

Fixing /client/readme.md #419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 20, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 .
Expand All @@ -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
```

4. Run yarn to install dependencies: .

```bash
yarn install
```

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

Expand Down