Skip to content

Latest commit

 

History

History
135 lines (103 loc) · 7.47 KB

README.md

File metadata and controls

135 lines (103 loc) · 7.47 KB


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.

Docker Cloud Build Status GitHub contributors GitHub issues GitHub stars GitHub closed issues GitHub pull requests GitHub release (latest by date) GitHub commit activity GitHub license Twitter Follow


Visual application builder

2_alt

3 Final_comment_final 5 6

All features

  • Visual app builder: 35+ built-in responsive widgets such as Tables, Charts, Lists, Forms, Progressbars, and more.
  • 20+ data sources: connect to databases, cloud storages and APIs.
  • Desktop & mobile: ;layout widths can be customised to support different screens.
  • Self-host: (supports Docker, Kubernetes, Heroku, AWS EC2, Google Cloud Run, and more).
  • Collaborate: add comments anywhere on the canvas and tag your team members.
  • Extend with plugins:: use our commandline tool to easily bootstrap new connectors.
  • Version control: every application have different versions with proper release cycle.
  • Run JS code: ability custom JavaScript snippets
  • Granular access control on organization-level and app-level.
  • low-code: write JS code almost anywhere in the builder. For example, the color property of text can be set to status === 'success' ? 'green' : 'red'
  • no-code query editors for all supported data sources.
  • Join and transform data: transform query results using just JavaScript code.
  • Secure: All the credentials are securely encrypted using aes-256-gcm.
  • Doesn't store data: ToolJet acts only as a proxy and doesn't store any data.
  • SSO: Supports multiple SSO providers

Quickstart

The easiest way to get started with ToolJet is by creating a ToolJet Cloud account. ToolJet Cloud offers a hosted solution of ToolJet. If you want to self-host ToolJet, kindly proceed to deployment documentation.

You can deploy ToolJet on Heroku for free using the one-click-deployment button below.

Try using Docker

Want to give ToolJet a quick spin on your local machine? You can run the following command from your terminal to have ToolJet up and running right away.

docker run \
  --name tooljet \
  --restart unless-stopped \
  -p 3000:3000 \
  -v tooljet_data:/var/lib/postgresql/13/main \
  tooljet/try:latest

Tutorials and examples

GitHub contributor leaderboard using ToolJet
Cryptocurrency dashboard using ToolJet
WhatsApp CRM using ToolJet
AWS S3 file explorer

Documentation

Documentation is available at https://docs.tooljet.com.

Self-hosted

You can use ToolJet cloud for a fully managed solution. If you want to self-host ToolJet, we have guides on deploying ToolJet on Kubernetes, AWS EC2, Docker, Heroku and more.

Provider Documentation
AWS EC2 Link
AWS EKS (Kubernetes) Link
GCP GKE (Kubernetes) Link
Azure AKS (Kubernetes) Link
Heroku Link
Docker Link
Google Cloud Run Link

Community support

For general help using ToolJet, please refer to the official documentation. For additional help, you can use one of these channels to ask a question:

  • Slack - Discussions with the community and the team.
  • GitHub - For bug reports and feature requests.
  • Twitter - Get the product updates easily.

Roadmap

Check out our roadmap to get informed of the latest features released and the upcoming ones.

Branching model

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.

Contributing

Kindly read our Contributing Guide 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.

Contributors

License

ToolJet © 2022, ToolJet Solutions Inc - Released under the GNU Affero General Public License v3.0.