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 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
20 changes: 20 additions & 0 deletions MANIFESTO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Lowcoder Manifesto

Dear Community,

We are excited to announce a new initiative to support and extend Openblocks, which unfortunately has been abandoned by its original team. Openblocks has been a critical part of many of our workflows, and we believe it's essential to keep it alive and thriving.

We have come together out of a shared passion for the project and a commitment to providing a toolchain that allows you to create apps blazingly fast using a simple, intuitive UI. We are dedicated to continuing the project's legacy under a new name, Lowcoder.

To provide continuous support to all members of the community, we have decided to form two individual teams:

_Lowcoder.org_ will remain fully open source, accessible to all, and free from any restrictions or limitations. As part of our commitment to the community, we will take over all maintenance, bug fixes, and feature development. We plan to prioritize stability and reliability while also introducing new features and enhancements to keep pace with evolving technology. We will maintain open communication channels, seek feedback, and actively engage with users and contributors to ensure that Lowcoder remains relevant and useful to all. We will be transparent about our development roadmap, progress, and any challenges that arise.

_Lowcoder.cloud_ will actively develop and maintain the enterprise version and provide a managed cloud offering using both the latest Lowcoder.org version and the proprietary Enterprise version.

The two teams will collaborate and support each other, focusing on a long-term partnership to ensure a healthy product and community.

We invite all members of the community to join us on this journey. Whether you are a user, contributor, or enterprise customer, your input and support are critical to the success of Lowcoder. Let's work together to keep this project alive and thriving for many years to come.

Sincerely,
The Lowcoder Team
66 changes: 25 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,88 +1,72 @@
<div align="center">
<h1 style="border-bottom: none">
<b><a href="https://openblocks.dev/">Openblocks</a></b><br />
<b>Lowcoder</b><br />
The Open Source Retool Alternative
</h1>
<p>
Build internal tools fast, with no limitations
</p>
</div>

> **Note**
> Lowcoder continues from the abandoned Openblocks project. For more information read our [manifesto](MANIFESTO.md).

<img src="/docs/.gitbook/assets/Bu2fpz1h01.gif"/>

## 📢 Use Openblocks in 3 steps
## 📢 Use Lowcoder in 3 steps
1. Connect to any data sources or APIs.
2. Build UI with 50+ components.
3. Share with colleagues and customers.
## 💡 Why Openblocks
## 💡 Why Lowcoder
It's cumbersome to create a single app. You had to design user interfaces, write code in multiple languages and frameworks, and understand how all of that code works together.

Low-code/No-code platforms are fast to get started with but quickly become unmaintainable and inflexible. This creates more problems than it solves.

Retool-like solutions are great for their simplicity and flexibility, but they can also be limited in different ways compared to frameworks like React/Vue.

Openblocks wants to take a step forward. More specifically, Openblocks is
Lowcoder wants to take a step forward. More specifically, Lowcoder is
- An all-in-one IDE to create internal or customer-facing apps.
- A place to create, build and share building blocks of web applications.
- A domain-specific language that UI-configurable block is the first-class citizen.

## 🪄 Features
- **Visual UI builder** with 50+ built-in components.
- **Module and Query Library** for reusable components and queries in the UI builder.
- **Custom components** to share through React and Openblocks SDK (instead of iFrame).
- **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 Openblocks 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.
- **Audit logs** to track activities and ensure compliance.

## 🏆 Comparisons
### Openblocks vs Retool
- Openblocks is open-source. You don't need to worry about vendor lock-in or being stuck with an outdated version of the software.
- In Openblocks, developers can create and use their own components instead of depending on official updates.
- Openblocks supports left menu navigation (like most sites do). Retool has header navigation only.
### Openblocks vs Appsmith, Tooljet
- Openblocks has more components and richer configuration than Appsmith and Tooljet.
- In Openblocks, you can choose auto-height or fixed-height mode for your components, while Appsmith supports fixed-height mode only.
- In Openblocks, you can reuse common structures when building apps with modules and query library features.
### Lowcoder vs Retool
- Lowcoder is open-source. You don't need to worry about vendor lock-in or being stuck with an outdated version of the software.
- In Lowcoder, developers can create and use their own components instead of depending on official updates.
- Lowcoder supports left menu navigation (like most sites do). Retool has header navigation only.
### Lowcoder vs Appsmith, Tooljet
- Lowcoder has more components and richer configuration than Appsmith and Tooljet.
- In Lowcoder, you can choose auto-height or fixed-height mode for your components, while Appsmith supports fixed-height mode only.
- In Lowcoder, you can reuse common structures when building apps with modules and query library features.

## 👐 Support and Community
If you have any questions, please feel free to contact us or share with our community. Our team is here ready to help.

📮 Chat with us on [Discord](https://discord.com/invite/z5W2YHXdtt)
📮 Chat with us on [Discord](https://discord.gg/vByQwGT2Yx)

📑 Search for solutions in our [Documentation](https://docs.openblocks.dev/)
📑 Search for solutions in our [Documentation](docs)

🔎 Submit an issue here on [GitHub](https://github.com/openblocks-dev/openblocks/issues)
🔎 Submit an issue here on [GitHub](https://github.com/lowcoder-org/lowcoder/issues)

## 💻 Deployment Options
You can access Openblocks from [cloud-hosted version](https://cloud.openblocks.dev/) at any time, or use the following resources for deploying Openblocks on different platforms:
- [Docker](https://docs.openblocks.dev/self-hosting)
- [AWS AMI](https://docs.openblocks.dev/self-hosting/aws-ami)
- [DigitalOcean](https://docs.openblocks.dev/self-hosting/digitalocean)
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](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/openblocks-dev/openblocks/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)
- [Frontend contributing guide](https://github.com/lowcoder-org/lowcoder/tree/develop/client)
6 changes: 3 additions & 3 deletions app.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "Openblocks",
"description": "Openblocks is a developer-friendly open-source low code platform to build internal apps within minutes.",
"repository": "https://github.com/openblocks-dev/openblocks",
"name": "Lowcoder",
"description": "Lowcoder is a developer-friendly open-source low code platform to build internal apps within minutes.",
"repository": "https://github.com/lowcoder-org/lowcoder",
"logo": "https://cdn-files.openblocks.dev/logo.png",
"keywords": [
"low code",
Expand Down
6 changes: 3 additions & 3 deletions client/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Openblocks' frontend
# Lowcoder frontend

## How to contribute

Expand All @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ npm start

## Build

Build current comp lib into a .tgz file that you can upload it to the Openblocks Comp Market.
Build current comp lib into a .tgz file that you can upload it to the Lowcoder Comp Market.

Before build you should change the version in package.json file.

Expand Down
2 changes: 1 addition & 1 deletion client/packages/openblocks-comps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ npm start

## Build

Build current comp lib into a .tgz file that you can upload it to the Openblocks Comp Market.
Build current comp lib into a .tgz file that you can upload it to the Lowcoder Comp Market.

Before build you should change the version in package.json file.

Expand Down
2 changes: 1 addition & 1 deletion client/packages/openblocks-design/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# openblocks-design

Openblocks base react components.
Lowcoder base react components.

When add new components, you should rebuild it with:

Expand Down
2 changes: 1 addition & 1 deletion client/packages/openblocks-plugin-demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ npm start

## Build

Build current comp lib into a .tgz file that you can upload it to the Openblocks Comp Market.
Build current comp lib into a .tgz file that you can upload it to the Lowcoder Comp Market.

Before build you should change the version in package.json file.

Expand Down
16 changes: 8 additions & 8 deletions client/packages/openblocks-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ npm:
npm install openblocks-sdk
```

## Integrate Openblocks' app/module into existing app page
## Integrate Lowcoder's app/module into existing app page

1. Publish your app/module in Openblocks.
1. Publish your app/module in Lowcoder.
2. Set the app/module's access privilege as public.
3. Add code in your existing app as below.

Expand All @@ -36,12 +36,12 @@ import { OpenblocksAppView } from "openblocks-sdk";

#### OpenblocksViewProps

| Name | Type | Description | Default value |
| ---------------------- | --------------------------- | --------------------------------------------------------------------------------------- | -------------------------- |
| appId | string | The app's id in Openblocks. Required! | -- |
| baseUrl | string | Openblocks' 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
Loading