Skip to content

Commit 72abc0b

Browse files
author
FalkWolsky
committed
Update Netlify Build Process in Readme
1 parent 77135de commit 72abc0b

File tree

1 file changed

+70
-1
lines changed

1 file changed

+70
-1
lines changed

client/README.md

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,73 @@ When you finish developing and testing the plugin, you can publish it into the n
116116
yarn build --publish
117117
```
118118

119-
You can check a code demo here: [Code Demo on Github](https://github.com/lowcoder-org/lowcoder/tree/main/client/packages/lowcoder-plugin-demo)
119+
You can check a code demo here: [Code Demo on Github](https://github.com/lowcoder-org/lowcoder/tree/main/client/packages/lowcoder-plugin-demo)
120+
121+
# Deployment of the Lowcoder Frontend to Netlify (Local Build Flow)
122+
123+
## ⚙️ Prerequisites
124+
125+
* Node.js & Yarn installed
126+
* Netlify CLI installed:
127+
128+
```bash
129+
npm install -g netlify-cli
130+
```
131+
132+
* Netlify CLI authenticated:
133+
134+
```bash
135+
netlify login
136+
```
137+
138+
* The project is linked to the correct Netlify site:
139+
140+
```bash
141+
cd client
142+
netlify link
143+
```
144+
145+
---
146+
147+
## 🛠 Setup `netlify.toml` (only once)
148+
149+
Inside the `client/` folder, create or update `netlify.toml`:
150+
151+
```toml
152+
[build]
153+
base = "client"
154+
command = "yarn workspace lowcoder build"
155+
publish = "client/packages/lowcoder/build"
156+
```
157+
158+
This ensures Netlify uses the correct build and publish paths when building locally.
159+
160+
---
161+
162+
## 🚀 Deployment Steps
163+
164+
1️⃣ Navigate into the `client` folder:
165+
166+
```bash
167+
cd client
168+
```
169+
170+
2️⃣ Run local build (with Netlify environment variables injected):
171+
172+
```bash
173+
netlify build
174+
```
175+
176+
3️⃣ Deploy to production:
177+
178+
```bash
179+
netlify deploy --prod --dir=packages/lowcoder/build
180+
```
181+
182+
---
183+
184+
## 🔧 Notes
185+
186+
* This local build flow fully honors the environment variables configured in Netlify.
187+
* No build happens on Netlify servers — only the deploy step runs on Netlify.
188+
* This approach avoids Netlify’s build memory limits.

0 commit comments

Comments
 (0)