Skip to content

Commit b77d53f

Browse files
committed
update readme
1 parent 1c5846d commit b77d53f

File tree

1 file changed

+56
-38
lines changed

1 file changed

+56
-38
lines changed

README.md

Lines changed: 56 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,66 @@
1-
# Openblocks.dev
2-
## Build internal tools fast, with no limitations. The open-source alternative to Retool.
3-
<img src="https://3434528005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpL1Hcv4CAzkEXttydyWt%2Fuploads%2FrNzTjsVNjZzTutAYC7Md%2Fimg_v2_34465665-d081-43bd-9513-24b05755198g.gif?alt=media&token=a850499f-e6f4-4ef2-97db-8f08eaf66477"/>
1+
<div align="center">
2+
<h1 style="border-bottom: none">
3+
<b><a href="https://cloud.openblocks.dev">Openblocks</a></b><br />
4+
The Open Source Retool Alternative
5+
</h1>
6+
<p>
7+
Build internal tools fast, with no limitations
8+
</p>
9+
</div>
410

5-
## Use Openblocks in 3 steps
6-
* Connect to any datasource or api.
7-
* Build UI with 50+ components.
8-
* Share with collegues and customers.
11+
<img src="https://3434528005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpL1Hcv4CAzkEXttydyWt%2Fuploads%2FrNzTjsVNjZzTutAYC7Md%2Fimg_v2_34465665-d081-43bd-9513-24b05755198g.gif?alt=media&token=a850499f-e6f4-4ef2-97db-8f08eaf66477"/>
912

10-
## Why Openblocks
11-
It is cumbersome to create a single app, you have to design user interfaces, write code in multiple languages and frameworks, understand how all of that code works together.
13+
## 📢 Use Openblocks in 3 steps
14+
1. Connect to any data sources or APIs.
15+
2. Build UI with 50+ components.
16+
3. Share with collegues and customers.
17+
## 💡 Why Openblocks
18+
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.
1219

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

1522
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.
1623

17-
Openblocks wants to take it forward. More specifically, Openblocks is
18-
* An all-in-one IDE to create internal or customer-facing apps.
19-
* A place to create, build and share building blocks of web applications.
20-
* A domain specific language that UI-configurable block is the first class citizen.
21-
22-
## Features
23-
* Visual UI builder with 50+ built-in components.
24-
* Native connection to PostgresSQL, MongoDB, Mysql, Redis, Elasticsearch, RestAPI, SMTP etc.
25-
* Write Javascript everywhere, use Javascript to transform data, control components etc.
26-
* Module and Query library, create reusable components/queries using the UI builder.
27-
* Create and share custom components using react and openblocks-sdk(instead of iFrame). (pre-alpha).
28-
* Embed openblocks pages as a react component(instead of iFrame).
29-
* RBAC based access management
30-
* Theme support
31-
* auto-save and rollback to history
32-
* Audit logs
33-
34-
## Comparisons
35-
### Openblocks vs Retool
36-
* Openblocks is open-source. You don't have to worry about vendor lockin or being stuck with an outdated version of the software.
37-
* In Openblocks, developers can create and use their own components instead of depending on offical updates.
38-
* Openblocks supports left menu navigation (like most sites do). Retool has header navigation only.
24+
Openblocks wants to take a step forward. More specifically, Openblocks is
25+
- An all-in-one IDE to create internal or customer-facing apps.
26+
- A place to create, build and share building blocks of web applications.
27+
- A domain-specific language that UI-configurable block is the first-class citizen.
3928

29+
## 🪄 Features
30+
- **Visual UI builder** with 50+ built-in components.
31+
- **Module and Query Library** for reusable components and queries in the UI builder.
32+
- **Custom components** to share through React and Openblocks SDK (instead of iFrame). (Pre-alpha)
33+
- **Native connections** to PostgresSQL, MongoDB, MySQL, Redis, Elasticsearch, RestAPI, SMTP, etc.
34+
- **JavaScript supported everywhere** to transform data, control components, etc.
35+
- **Embed Openblocks pages as a React component** (instead of iFrame).
36+
- **Role-based access control (RBAC)** for granular permission management.
37+
- **Auto-saved and restorable history** for release and version control.
38+
- **DIY app themes** to precisely align with your company's content.
39+
- **Audit logs** to track activities and ensure compliance.
40+
41+
## 🏆 Comparisons
42+
### Openblocks vs Retool
43+
- Openblocks is open-source. You don't need to worry about vendor lock-in or being stuck with an outdated version of the software.
44+
- In Openblocks, developers can create and use their own components instead of depending on offical updates.
45+
- Openblocks supports left menu navigation (like most sites do). Retool has header navigation only.
4046
### Openblocks vs Appsmith, Tooljet
41-
* Openblocks has more components and richer configuration than Appsmith and Tooljet.
42-
* In Openblocks, you can choose between auto-height or fixed-height mode for your components, while Appsmith supports fixed-height mode only.
43-
* In Openblocks, you can reuse common structures when building apps using module and query library features.
47+
- Openblocks has more components and richer configuration than Appsmith and Tooljet.
48+
- In Openblocks, you can choose auto-height or fixed-height mode for your components, while Appsmith supports fixed-height mode only.
49+
- In Openblocks, you can reuse common structures when building apps with modules and query library features.
50+
51+
## 👐 Support and Community
52+
If you have any questions, please feel free to contact us or share with our community. Our team is here ready to help.
53+
54+
📮 Chat with us on [Discord](https://discord.com/invite/z5W2YHXdtt)
55+
56+
📑 Search for solutions in our [Documentation](https://docs.openblocks.dev/)
57+
58+
🔎 Submit an issue here on [GitHub](https://github.com/openblocks-dev/openblocks/issues)
4459

60+
## 💻 Deployment Options
61+
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:
62+
- [Docker](https://docs.openblocks.dev/self-hosting)
4563

46-
### Contributing
47-
* Language support: If you have experience with a language that isn't currently supported by our product, send us a pull request.
48-
* Create and share components/demos: If you've created something that might be useful to others, add the link here.
64+
## 💪 Contributing
65+
- Language support: If you have experience with a language that isn't currently supported by our product, send us a pull request.
66+
- Create and share components or demos: If you've created something that might be useful to others, add the link here.

0 commit comments

Comments
 (0)