Skip to content

Rebranding - Docs and build files #8

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 15 commits into from
May 4, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
refactor: rebranding
Replaced references to Openblocks where it made sense based on feedback.
  • Loading branch information
falnyr committed May 4, 2023
commit c12d3c0384686e18bb46267814772ff038c88b44
23 changes: 2 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Lowcoder wants to take a step forward. More specifically, Lowcoder is
- **Custom components** to share through React and Lowcoder SDK (instead of iFrame).
- **Native connections** to PostgreSQL, MongoDB, MySQL, Redis, Elasticsearch, REST API, SMTP, etc.
- **JavaScript supported everywhere** to transform data, control components, etc.
- **Embed Lowcoder pages as a React component** (instead of iFrame). [Demo](https://github.com/openblocks-dev/openblocks-sdk-demo)
- **Embed Lowcoder pages as a React component** (instead of iFrame). [Demo](https://github.com/lowcoder-org/lowcoder-sdk-demo)
- **Role-based access control (RBAC)** for granular permission management.
- **Auto-saved and restorable history** for release and version control.
- **DIY app themes** to precisely align with your company's content.
Expand Down Expand Up @@ -64,28 +64,9 @@ If you have any questions, please feel free to contact us or share with our comm
You can access Lowcoder from [cloud-hosted version](https://www.lowcoder.cloud/) at any time, or use the following resources for deploying Lowcoder on different platforms:
- [Docker](docs/self-hosting/README.md)
- [AWS AMI](docs/self-hosting/aws-ami.md) (Coming Soon)
- [DigitalOcean](https://docs.openblocks.dev/self-hosting/digitalocean) (Coming Soon)
- [DigitalOcean](docs/self-hosting/digitalocean.md) (Coming Soon)

## 💪 Contributing
- Language support: If you have experience with a language that isn't currently supported by our product, send us a pull request.
- Create and share components or demos: If you've created something that might be useful to others, add the link here.
- [Frontend contributing guide](https://github.com/lowcoder-org/lowcoder/tree/develop/client)

## 📝 Examples(WIP)
- [Basic CRUD](https://cloud.openblocks.dev/apps/6374b8dbc23a1103804cc23e/view)
- [Simple table horizontal scroll and pagination demo](https://cloud.openblocks.dev/apps/6377695dc54c5224c70e9770/view)
- [Pagination with temporary state demo](https://cloud.openblocks.dev/apps/6379cdd9f02c6e6ecc1d37ff/view)
- [Import third-party JS lib demo](https://cloud.openblocks.dev/apps/637a1797c54c5224c70efed3/view)
- [JSON schema parsing using a third-party lib](https://cloud.openblocks.dev/apps/638dc95c75cfb658566143c5/view)
- [Custom Echarts demo](https://cloud.openblocks.dev/apps/63779dd6c54c5224c70ea537/view), [Echarts source](https://echarts.apache.org/examples/en/editor.html?c=area-stack)
- [Periodically user action report demo](https://cloud.openblocks.dev/apps/637f38daa899fe1ffcb17f0b/view)
- [Generate PDF using jsPdf](https://cloud.openblocks.dev/apps/6388610b0a254922d92e3882/view)
- [Excel Explorer](https://cloud.openblocks.dev/apps/6392ff5d51cd8a59114b0c2c/view)
- [File upload with REST API](https://cloud.openblocks.dev/apps/63a2651e660ad97d59eb4a51/view)
- [Shopping cart demo using transformers/state/drawer](https://cloud.openblocks.dev/apps/63a422a344075b798fe3ae06/view)
- [Module demo: color picker](https://cloud.openblocks.dev/apps/63a58f1e85d4cb49cebad1d4/view)
- [S3 File Management](https://cloud.openblocks.dev/apps/63c7aa55686c4f301cf4d755/view)
- [Custom Markdown Style](https://cloud.openblocks.dev/apps/63c8bdb9de760726cd253c90/view)
- [Use JS query to orchestrate other queries](https://cloud.openblocks.dev/apps/63c8fb1e0279b679be2b5a09/view)
- [Data responder demo](https://cloud.openblocks.dev/apps/63f84d23f5f6f66102fedf81/view)
- [Change theme by code](https://cloud.openblocks.dev/apps/63f84ca9f5f6f66102fedf3b/view)
4 changes: 2 additions & 2 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
Simply run below command to start a backend server.

```bash
docker run -d --name openblocks -p 3000:3000 -v "$PWD/stacks:/openblocks-stacks" openblocksdev/openblocks-ce
docker run -d --name openblocks -p 3000:3000 -v "$PWD/stacks:/openblocks-stacks" lowcoderorg/lowcoder-ce
```

For more information, view our doc https://docs.openblocks.dev/self-hosting
For more information, view our [docs](../docs/self-hosting)

#### Build Docker image from source

Expand Down
12 changes: 6 additions & 6 deletions client/packages/openblocks-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ import { OpenblocksAppView } from "openblocks-sdk";

#### OpenblocksViewProps

| Name | Type | Description | Default value |
| ---------------------- | --------------------------- | --------------------------------------------------------------------------------------- | -------------------------- |
| appId | string | The app's id in Lowcoder. Required! | -- |
| baseUrl | string | Lowcoder's api base url | https://api.openblocks.dev |
| onModuleEventTriggered | (eventName: string) => void | Triggered when module's custom event is triggered. Works only when the app is a module. | -- |
| onModuleOutputChange | (output: any) => void | Triggered when module's outputs change. Works only when the app is a module. | -- |
| Name | Type | Description | Default value |
|------------------------|-----------------------------|-----------------------------------------------------------------------------------------|---------------|
| appId | string | The app's id in Lowcoder. Required! | -- |
| baseUrl | string | Lowcoder's api base url | -- |
| onModuleEventTriggered | (eventName: string) => void | Triggered when module's custom event is triggered. Works only when the app is a module. | -- |
| onModuleOutputChange | (output: any) => void | Triggered when module's outputs change. Works only when the app is a module. | -- |

#### Invoke module methods

Expand Down
10 changes: 5 additions & 5 deletions deploy/docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ Image can be configured by setting environment variables.
| `ENCRYPTION_PASSWORD` | Encryption password | `lowcoder.org` |
| `ENCRYPTION_SALT` | Salt used for encrypting password | `lowcoder.org` |
| `CORS_ALLOWED_DOMAINS` | CORS allowed domains | `*` |
| `OPENBLOCKS_API_SERVICE_URL` | Lowcoder API service URL | `http://localhost:8080` |
| `OPENBLOCKS_NODE_SERVICE_URL` | Lowcoder Node service (js executor) URL | `http://localhost:6060` |
| `LOWCODER_API_SERVICE_URL` | Lowcoder API service URL | `http://localhost:8080` |
| `LOWCODER_NODE_SERVICE_URL` | Lowcoder Node service (js executor) URL | `http://localhost:6060` |


## Building api-service image
Expand Down Expand Up @@ -90,7 +90,7 @@ Image can be configured by setting environment variables.
| --------------------------------| --------------------------------------------------------------------| ------------------------------------------------------- |
| `PUID` | ID of user running services. It will own all created logs and data. | `9001` |
| `PGID` | ID of group of the user running services. | `9001` |
| `OPENBLOCKS_API_SERVICE_URL` | Lowcoder API service URL | `http://localhost:8080` |
| `LOWCODER_API_SERVICE_URL` | Lowcoder API service URL | `http://localhost:8080` |

## Building web frontend image

Expand All @@ -112,7 +112,7 @@ Image can be configured by setting environment variables.
| --------------------------------| --------------------------------------------------------------------| ------------------------------------------------------- |
| `PUID` | ID of user running services. It will own all created logs and data. | `9001` |
| `PGID` | ID of group of the user running services. | `9001` |
| `OPENBLOCKS_API_SERVICE_URL` | Lowcoder API service URL | `http://localhost:8080` |
| `OPENBLOCKS_NODE_SERVICE_URL` | Lowcoder Node service (js executor) URL | `http://localhost:6060` |
| `LOWCODER_API_SERVICE_URL` | Lowcoder API service URL | `http://localhost:8080` |
| `LOWCODER_NODE_SERVICE_URL` | Lowcoder Node service (js executor) URL | `http://localhost:6060` |


6 changes: 3 additions & 3 deletions deploy/docker/docker-compose-multi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ services:
environment:
PUID: "9001"
PGID: "9001"
OPENBLOCKS_API_SERVICE_URL: "http://lowcoder-api-service:8080"
LOWCODER_API_SERVICE_URL: "http://lowcoder-api-service:8080"
restart: unless-stopped
depends_on:
- lowcoder-api-service
Expand All @@ -70,8 +70,8 @@ services:
environment:
PUID: "9001"
PGID: "9001"
OPENBLOCKS_API_SERVICE_URL: "http://lowcoder-api-service:8080"
OPENBLOCKS_NODE_SERVICE_URL: "http://lowcoder-node-service:6060"
LOWCODER_API_SERVICE_URL: "http://lowcoder-api-service:8080"
LOWCODER_NODE_SERVICE_URL: "http://lowcoder-node-service:6060"
restart: unless-stopped
depends_on:
- lowcoder-node-service
Expand Down
4 changes: 2 additions & 2 deletions deploy/docker/docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ services:
ENCRYPTION_SALT: "lowcoder.org"
CORS_ALLOWED_DOMAINS: "*"
# api and node service parameters
OPENBLOCKS_API_SERVICE_URL: "http://localhost:8080"
OPENBLOCKS_NODE_SERVICE_URL: "http://localhost:6060"
LOWCODER_API_SERVICE_URL: "http://localhost:8080"
LOWCODER_NODE_SERVICE_URL: "http://localhost:6060"
volumes:
- ./lowcoder-stacks:/lowcoder-stacks
restart: unless-stopped
Expand Down
10 changes: 5 additions & 5 deletions deploy/docker/frontend/01-update-nginx-conf.sh
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#!/bin/sh

set -e
set -e

sed -i "s@__OPENBLOCKS_API_SERVICE_URL__@${OPENBLOCKS_API_SERVICE_URL:=http://localhost:8080}@" /etc/nginx/nginx.conf
sed -i "s@__OPENBLOCKS_NODE_SERVICE_URL__@${OPENBLOCKS_NODE_SERVICE_URL:=http://localhost:6060}@" /etc/nginx/nginx.conf
sed -i "s@__LOWCODER_API_SERVICE_URL__@${LOWCODER_API_SERVICE_URL:=http://localhost:8080}@" /etc/nginx/nginx.conf
sed -i "s@__LOWCODER_NODE_SERVICE_URL__@${LOWCODER_NODE_SERVICE_URL:=http://localhost:6060}@" /etc/nginx/nginx.conf

echo "nginx config updated with:"
echo " Lowcoder api service URL: ${OPENBLOCKS_API_SERVICE_URL}"
echo " Lowcoder node service URL: ${OPENBLOCKS_NODE_SERVICE_URL}"
echo " Lowcoder api service URL: ${LOWCODER_API_SERVICE_URL}"
echo " Lowcoder node service URL: ${LOWCODER_NODE_SERVICE_URL}"
4 changes: 2 additions & 2 deletions deploy/docker/frontend/nginx.conf
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ http {
location /api {
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-Host $host;
proxy_pass __OPENBLOCKS_API_SERVICE_URL__;
proxy_pass __LOWCODER_API_SERVICE_URL__;
}

location /node-service/plugin-icons {
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-Host $host;
proxy_pass __OPENBLOCKS_NODE_SERVICE_URL__;
proxy_pass __LOWCODER_NODE_SERVICE_URL__;
}
}
}
2 changes: 1 addition & 1 deletion deploy/docker/node-service/entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ set -e

export USER_ID=${PUID:=9001}
export GROUP_ID=${PGID:=9001}
export API_HOST="${OPENBLOCKS_API_SERVICE_URL:=http://localhost:8080}"
export API_HOST="${LOWCODER_API_SERVICE_URL:=http://localhost:8080}"

# Run init script
echo "Initializing node-service..."
Expand Down
8 changes: 4 additions & 4 deletions deploy/helm/templates/frontend/configMap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ data:
PUID: {{ .Values.frontend.config.userId | default "9001" | quote }}
PGID: {{ .Values.frontend.config.groupId | default "9001" | quote }}
{{- if .Values.frontend.config.apiServiceUrl }}
OPENBLOCKS_API_SERVICE_URL: {{ .Values.frontend.config.apiServiceUrl | trimSuffix "/" | quote }}
LOWCODER_API_SERVICE_URL: {{ .Values.frontend.config.apiServiceUrl | trimSuffix "/" | quote }}
{{- else }}
OPENBLOCKS_API_SERVICE_URL: "http://{{ $name }}-api-service:{{ .Values.apiService.service.port }}"
LOWCODER_API_SERVICE_URL: "http://{{ $name }}-api-service:{{ .Values.apiService.service.port }}"
{{- end }}
{{- if .Values.frontend.config.nodeServiceUrl }}
OPENBLOCKS_NODE_SERVICE_URL: {{ .Values.frontend.config.nodeServiceUrl | trimSuffix "/" | quote }}
LOWCODER_NODE_SERVICE_URL: {{ .Values.frontend.config.nodeServiceUrl | trimSuffix "/" | quote }}
{{- else }}
OPENBLOCKS_NODE_SERVICE_URL: "http://{{ $name }}-node-service:{{ .Values.nodeService.service.port }}"
LOWCODER_NODE_SERVICE_URL: "http://{{ $name }}-node-service:{{ .Values.nodeService.service.port }}"
{{- end }}

4 changes: 2 additions & 2 deletions deploy/helm/templates/node-service/configMap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ data:
PUID: {{ .Values.nodeService.config.userId | default "9001" | quote }}
PGID: {{ .Values.nodeService.config.groupId | default "9001" | quote }}
{{- if .Values.nodeService.apiServiceUrl }}
OPENBLOCKS_API_SERVICE_URL: {{ .Values.nodeService.apiServiceUrl | quote }}
LOWCODER_API_SERVICE_URL: {{ .Values.nodeService.apiServiceUrl | quote }}
{{- else }}
OPENBLOCKS_API_SERVICE_URL: "http://{{ $name }}-api-service:{{ .Values.apiService.service.port }}"
LOWCODER_API_SERVICE_URL: "http://{{ $name }}-api-service:{{ .Values.apiService.service.port }}"
{{- end }}
Binary file added docs/.gitbook/assets/server-setup-image1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/server-setup-image2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/server-setup-image3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/server-setup-image4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/server-setup-image5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/server-setup-start.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
## Data sources

* [Data source basics](data-sources/data-source-basics.md)
* [Configure IP allowlists](data-sources/configure-ip-allowlists.md)
* [Connect to databases](data-sources/connect-to-databases/README.md)
* [Big Query](data-sources/connect-to-databases/big-query.md)
* [ClickHouse](data-sources/connect-to-databases/clickhouse.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/build-apps/component-guides/charts-and-graphs.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ In most types of charts, the **Chart series** (Y-axis) presents numeric values f

Apart from the built-in charts and graphs, you can also plot your data with [Apache ECharts](https://echarts.apache.org/en/index.html), an open-source JS visualization library. You only need to complete the **Configuration** > **Option** field in JSON format. For detailed information, see [ECharts docs](https://echarts.apache.org/en/option.html#title) and [ECharts examples](https://echarts.apache.org/examples/en/index.html).

For an instance of using Echarts, see [Stacked Area Chart](https://cloud.openblocks.dev/apps/63779dd6c54c5224c70ea537/view).
For an instance of using Echarts, see Stacked Area Chart:

<figure><img src="../../.gitbook/assets/charts-and-graphs-7.png" alt=""><figcaption></figcaption></figure>

Expand Down
4 changes: 2 additions & 2 deletions docs/build-apps/component-guides/drawer.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The following sections guide you through how to open and close a drawer by click

### Trigger openDrawer

Usually, in an app, you trigger opening a drawer by an event such as clicking a button. For example, in the [Online Shopping demo](https://cloud.openblocks.dev/apps/63a422a344075b798fe3ae06/view), opening a drawer to display the shopping cart is implemented in the following steps.
Usually, in an app, you trigger opening a drawer by an event such as clicking a button. Opening a drawer to display the shopping cart is implemented in the following steps.

1. Add a button and rename it as `gotoCart`.
2. Set the event handler of the button. Select "Control component" as the **Action** and select the component "cart" and method "openDrawer". All these settings are auto-saved.&#x20;
Expand All @@ -46,7 +46,7 @@ Usually, in an app, you trigger opening a drawer by an event such as clicking a

### Trigger closeDrawer

Triggerring "closeDrawer" is similar to triggering "openDrawer". When setting up the event handler, select the method "closeDrawer". For example, in the [Online Shopping demo](https://cloud.openblocks.dev/apps/63a422a344075b798fe3ae06/view), closing a drawer that displays the shopping cart is implemented in the following steps.
Triggerring "closeDrawer" is similar to triggering "openDrawer". When setting up the event handler, select the method "closeDrawer". Closing a drawer that displays the shopping cart is implemented in the following steps.

1. Add a button and rename it as `gobackShopping`.
2. Set the event handler of the button. Select "Control component" as the **Action** and select the component "cart" and method "closeDrawer". All these settings are auto-saved.&#x20;
Expand Down
2 changes: 1 addition & 1 deletion docs/build-apps/component-guides/file-upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Files uploaded via the file upload component are stored in browser cache memory

## Use case: Upload images to Postman Echo API

This example uploads images to Postman [Echo API](https://learning.postman.com/docs/developer/echo-api/), and inspects the query result whether the files are sent successfully to the remote server. For more details, see [Image uploader](https://cloud.openblocks.dev/apps/63a2651e660ad97d59eb4a51/view).
This example uploads images to Postman [Echo API](https://learning.postman.com/docs/developer/echo-api/), and inspects the query result whether the files are sent successfully to the remote server.

<figure><img src="../../.gitbook/assets/file-upload-8.gif" alt=""><figcaption></figcaption></figure>

Expand Down
2 changes: 1 addition & 1 deletion docs/build-apps/component-guides/use-markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ All Markdown syntax is valid in Lowcoder.
* **Lists**: Use hyphen (-), asterisk (∗), or plus sign (+) followed by a whitespace to create an unordered list, and use numbers followed by a period (.) to create an ordered list.
* **Code**: Use backticks (\`) before and after code to denote `` `code` `` in plain text, and three backticks (\`\`\`) to present ` ```code block``` `.
* **Horizontal rules**: Use at least three asterisks (∗∗∗), hyphens (---), or underscores (\_ \_ \_) at the beginning of a line to create a horizontal rule.
* **Links**: Use square brackets (\[]) for the display text and parenthesis (()) for the link address. Note that no space should be inbetween. For example, `[Lowcoder](https://docs.openblocks.dev)`.
* **Links**: Use square brackets (\[]) for the display text and parenthesis (()) for the link address. Note that no space should be inbetween. For example, `[Lowcoder](https://github.com/lowcoder-org/lowcoder)`.
* **Images**: Use an exclamation mark (!) to start an image shiinsertion, and then use square bracket (\[]) for the alternative text and parenthesis (()) for the link address or source path. The caption can follow the parentheses or start at a new line.
* **Escaping characters**: Use backslash (\\) to display the special symbols that Markdown uses. For instance, to print ` `` ` in plain text, you should use `` \`\` `` in Markdown.&#x20;

Expand Down
Loading