2021-04-16 17:10:03 +00:00
< p align = "center" >
2021-12-03 11:09:21 +00:00
< img src = "https://user-images.githubusercontent.com/7828962/143565889-f4c51c89-fc7e-471c-90b6-42ae697bca6b.png" width = "200" / >
2021-04-16 17:10:03 +00:00
< br / >
2021-12-03 11:09:21 +00:00
Low-code framework for building internal tools.
2021-04-16 17:10:03 +00:00
< / p >
2021-04-23 16:07:53 +00:00
2021-12-03 11:09:21 +00:00
ToolJet is an **open-source low-code framework** to build and deploy internal tools quickly without much effort from the engineering teams. You can connect to your data sources, such as databases (like PostgreSQL, MongoDB, Elasticsearch, etc), API endpoints (ToolJet supports importing OpenAPI spec & OAuth2 authorization), and external services (like Stripe, Slack, Google Sheets, Airtable) and use our pre-built UI widgets to build internal tools.
2021-06-07 04:40:43 +00:00
2021-09-21 17:25:27 +00:00
2021-06-07 04:40:43 +00:00
[](https://github.com/ToolJet/ToolJet/issues)
[](https://github.com/ToolJet/ToolJet/stargazers)
2021-09-21 17:25:27 +00:00
2021-06-07 04:40:43 +00:00
[](https://github.com/ToolJet/ToolJet)
2021-09-21 17:25:27 +00:00
2021-05-17 04:34:00 +00:00
< p align = "center" >
2021-06-04 16:04:47 +00:00
< kbd >
2021-12-03 11:09:21 +00:00
< img src = "https://user-images.githubusercontent.com/7828962/144586771-c6d6cba5-8f79-4e0c-80b4-aa1a38657229.png" / >
2021-06-04 16:04:47 +00:00
< / kbd >
2021-05-17 04:34:00 +00:00
< / p >
2021-06-07 07:19:13 +00:00
2021-04-23 16:07:53 +00:00
## Features
2021-10-28 02:54:27 +00:00
- Visual app builder with widgets, such as tables, charts, modals, buttons, dropdowns, and more.
2021-12-03 11:09:21 +00:00
- All widgets are responsive
2021-07-03 17:35:58 +00:00
- Mobile 📱 & desktop layouts 🖥
2021-12-03 11:09:21 +00:00
- Dark mode
- Connect to databases, cloud storages and APIs.
- Deploy on-premise (supports Docker, Kubernetes, Heroku, AWS EC2, Google Cloud Run, and more).
2021-10-15 09:55:37 +00:00
- Granular access control on organization-level and app-level.
- Write JS code almost anywhere in the builder.
- Query editors for all supported data sources.
- Transform query results using JS code.
2021-05-17 04:34:00 +00:00
- All the credentials are securely encrypted using `aes-256-gcm` .
- ToolJet acts only as a proxy and doesn't store any data.
2021-10-15 09:55:37 +00:00
- Support for OAuth.
2021-04-23 16:07:53 +00:00
2021-05-17 04:34:00 +00:00
< hr >
## Quickstart
2021-12-03 11:09:21 +00:00
The easiest way to get started with ToolJet is by creating a [ToolJet Cloud ](https://tooljet.com ) account. ToolJet Cloud offers a hosted solution of ToolJet. If you want to self-host ToolJet, kindly proceed to [deployment documentation ](https://docs.tooljet.com/docs/deployment/architecture ).
2021-05-17 04:34:00 +00:00
2021-06-05 08:04:02 +00:00
You can deploy ToolJet on Heroku for free using the one-click-deployment button below.
2021-06-04 05:09:04 +00:00
< p align = "center" >
< a href = "https://heroku.com/deploy?template=https://github.com/tooljet/tooljet/tree/main" > < img src = "https://www.herokucdn.com/deploy/button.svg" / > < / a >
< / P >
## Examples
2021-12-03 11:09:21 +00:00
[GitHub contributor leaderboard using ToolJet ](https://blog.tooljet.io/building-a-github-contributor-leaderboard-using-tooljet/ )< br >
[Cryptocurrency dashboard using ToolJet ](https://blog.tooljet.com/how-to-build-a-cryptocurrency-dashboard-in-10-minutes/ )< br >
2021-12-13 05:05:04 +00:00
[WhatsApp CRM using ToolJet ](https://blog.tooljet.com/build-a-whatsapp-crm-using-tooljet-within-10-mins/ )< br >
2021-05-17 04:20:25 +00:00
2021-04-30 02:31:45 +00:00
## Documentation
2021-12-03 11:09:21 +00:00
Documentation is available at https://docs.tooljet.com.
2021-04-30 02:31:45 +00:00
2021-12-03 11:09:21 +00:00
- [Getting Started ](https://docs.tooljet.com )< br >
- [Deploying ](https://docs.tooljet.com/docs/deployment/architecture )< br >
- [Datasource Reference ](https://docs.tooljet.com/docs/data-sources/airtable/ )< br >
- [Widget Reference ](https://docs.tooljet.com/docs/widgets/button )
2021-04-30 02:31:45 +00:00
2021-05-24 19:39:08 +00:00
## Branching model
2021-10-24 15:24:10 +00:00
We use the git-flow branching model. The base branch is `develop` . If you are looking for a stable version, please use the main branch or tags labeled as v1.x.x.
2021-04-23 16:07:53 +00:00
## Contributing
2021-10-24 15:24:10 +00:00
Kindly read our [Contributing Guide ](CONTRIBUTING.md ) to learn and understand about our development process, how to propose bug fixes and improvements, and how to build and test your changes to ToolJet. < br >
2021-04-23 16:07:53 +00:00
2021-09-21 17:25:27 +00:00
## Contributors
< a href = "https://github.com/tooljet/tooljet/graphs/contributors" >
< img src = "https://contrib.rocks/image?repo=tooljet/tooljet" / >
< / a >
2021-04-23 16:07:53 +00:00
## Licence
2021-11-15 10:54:35 +00:00
ToolJet © 2021, ToolJet Solutions Inc - Released under the GNU Affero General Public License v3.0.
