mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-21 13:37:28 +00:00
d1bd60b8ac
* Accessibility for README Add accessibility features to markdown file based on: https://github.blog/2023-10-26-5-tips-for-making-your-github-profile-page-accessible/ * Accessibility for CODE_OF_CONDUCT Accessibility for markdowns, based on: https://github.blog/2023-10-26-5-tips-for-making-your-github-profile-page-accessible/ * Some accessibility, some typography * Fix email link
157 lines
9.3 KiB
Markdown
157 lines
9.3 KiB
Markdown
ToolJet is an **open-source low-code framework** to build and deploy internal tools with minimal engineering effort. ToolJet's drag-and-drop frontend builder allows you to create complex, responsive frontends within minutes. Additionally, you can integrate various data sources, including databases like PostgreSQL, MongoDB, and Elasticsearch; API endpoints with OpenAPI spec and OAuth2 support; SaaS tools such as Stripe, Slack, Google Sheets, Airtable, and Notion; as well as object storage services like S3, GCS, and Minio, to fetch and write data.
|
|
|
|
:star: If you find ToolJet useful, please consider giving us a star on GitHub! Your support helps us continue to innovate and deliver exciting features.
|
|
|
|
|
|
|
|
[](https://github.com/ToolJet/ToolJet/issues)
|
|
[](https://github.com/ToolJet/ToolJet/stargazers)
|
|
|
|
|
|
|
|
|
|
[](https://github.com/ToolJet/ToolJet)
|
|
[](https://twitter.com/ToolJet)
|
|
|
|
<p align="center">
|
|
<img src="https://user-images.githubusercontent.com/7828962/211444352-4d6d2e4a-13c9-4980-9e16-4aed4af9811b.png" alt="Tooljet dashboard showing inventory and orders"/>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img src="https://github.com/ToolJet/ToolJet/assets/25361949/0e711f3a-edb7-496b-8833-107de3826933"/>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<kbd>
|
|
<img src="https://user-images.githubusercontent.com/7828962/202402863-2851a072-9dca-4b8b-9473-0d044373928b.png" alt="Tooljet visual front end builder"/>
|
|
|
|
</kbd>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<kbd>
|
|
<img src="https://user-images.githubusercontent.com/7828962/211364385-10714e24-f1ac-4e72-a2a1-ec7dc2d412ab.png" alt="Tooljet database showing over 40 integrations"/>
|
|
</kbd>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<kbd>
|
|
<img src="https://user-images.githubusercontent.com/7828962/202402422-8f1df2a4-5c07-4125-9c2e-5450b90f464c.png" alt="Tooljet showing ability to run in Python, import your React component, and build your own plugins using the dev kit"/>
|
|
</kbd>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<kbd>
|
|
<img src="https://user-images.githubusercontent.com/7828962/202402574-7cd7c606-d751-4de1-ba56-abbedba54b13.png" alt="Deploy from anywhere, showing various cloud services"/>
|
|
</kbd>
|
|
</p>
|
|
|
|
|
|
## All features
|
|
|
|
- **Visual App Builder:** 40+ built-in responsive components, including Tables, Charts, Lists, Forms, and Progress Bars.
|
|
- **ToolJet Database:** Built-in no-code database.
|
|
- **Multi-Page:** Build an application with multiple pages.
|
|
- **Multiplayer editing:** Allows simultaneous app building by multiple developers.
|
|
- **40+ data sources:** Integrate with external databases, cloud storage, and APIs.
|
|
- **Desktop & mobile:** Customize layout widths to fit various screen sizes.
|
|
- **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 [command-line tool](https://www.npmjs.com/package/@tooljet/cli) to easily bootstrap new connectors.
|
|
- **Version control:** Manage multiple application versions with a structured release cycle.
|
|
- **Run JS & Python code:** Execute custom JavaScript and Python snippets.
|
|
- **Granular access control:** Set permissions at both group and app levels.
|
|
- **Low-code:** Use JS code almost anywhere within the builder, such as setting text color based on status with
|
|
`status === 'success' ? 'green' : 'red`.
|
|
- **No-code query editors:** Query Editors are available for all supported data sources.
|
|
- **Join and transform data:** Transform query results using JavaScript or Python code.
|
|
- **Secure:** All the credentials are securely encrypted using `aes-256-gcm`.
|
|
- **Data Privacy:** ToolJet serves solely as a proxy and does not store data.
|
|
- **SSO:** Supports multiple Single Sign-On providers.
|
|
|
|
<hr>
|
|
|
|
## Quickstart
|
|
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/setup/).
|
|
|
|
You can deploy ToolJet on Heroku using one-click deployment.
|
|
|
|
<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" alt="Deploy to Heroku" height=32></a>
|
|
<a href="https://cloud.digitalocean.com/apps/new?repo=https://github.com/ToolJet/ToolJet/tree/main"><img src="https://www.deploytodo.com/do-btn-blue.svg" alt="Deploy to DigitalOcean" height=32></a>
|
|
</p>
|
|
|
|
### 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.
|
|
|
|
```bash
|
|
docker run \
|
|
--name tooljet \
|
|
--restart unless-stopped \
|
|
-p 80:80 \
|
|
-v tooljet_data:/var/lib/postgresql/13/main \
|
|
tooljet/try:latest
|
|
```
|
|
|
|
## Tutorials and examples
|
|
|
|
[Time Tracker Application](https://docs.tooljet.com/docs/#quickstart-guide)<br>
|
|
[Build your own CMS using low-code](https://blog.tooljet.com/build-cms-using-lowcode-and-mongodb/)<br>
|
|
[AWS S3 Browser](https://blog.tooljet.com/build-an-aws-s3-broswer-with-tooljet/)<br>
|
|
|
|
## Documentation
|
|
Documentation is available at https://docs.tooljet.com.
|
|
|
|
- [Getting Started](https://docs.tooljet.com)<br>
|
|
- [Data source Reference](https://docs.tooljet.com/docs/data-sources/airtable/)<br>
|
|
- [Component Reference](https://docs.tooljet.com/docs/widgets/button)
|
|
|
|
## 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 |
|
|
| :------------- | :------------- |
|
|
| Digital Ocean | [Link](https://docs.tooljet.com/docs/setup/digitalocean) |
|
|
| Docker | [Link](https://docs.tooljet.com/docs/setup/docker) |
|
|
| Heroku | [Link](https://docs.tooljet.com/docs/setup/heroku) |
|
|
| AWS EC2 | [Link](https://docs.tooljet.com/docs/setup/ec2) |
|
|
| AWS ECS | [Link](https://docs.tooljet.com/docs/setup/ecs) |
|
|
| OpenShift | [Link](https://docs.tooljet.com/docs/setup/openshift) |
|
|
| Helm | [Link](https://docs.tooljet.com/docs/setup/helm) |
|
|
| AWS EKS (Kubernetes) | [Link](https://docs.tooljet.com/docs/setup/kubernetes) |
|
|
| GCP GKE (Kubernetes) | [Link](https://docs.tooljet.com/docs/setup/kubernetes-gke) |
|
|
| Azure AKS (Kubernetes) | [Link](https://docs.tooljet.com/docs/setup/kubernetes-aks) |
|
|
| Azure Container | [Link](https://docs.tooljet.com/docs/setup/azure-container) |
|
|
| Google Cloud Run | [Link](https://docs.tooljet.com/docs/setup/google-cloud-run) |
|
|
| Deploying ToolJet client | [Link](https://docs.tooljet.com/docs/setup/client) |
|
|
| Deploying ToolJet on a Subpath | [Link](https://docs.tooljet.com/docs/setup/tooljet-subpath/) |
|
|
|
|
## Marketplace
|
|
ToolJet can now be found on both AWS and Azure Marketplaces, making it simpler than ever to access and deploy our app-building platform.
|
|
|
|
Find ToolJet on AWS Marketplace [here](https://aws.amazon.com/marketplace/pp/prodview-fxjto27jkpqfg?sr=0-1&ref_=beagle&applicationId=AWSMPContessa) and explore seamless integration on Azure Marketplace [here](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/tooljetsolutioninc1679496832216.tooljet?tab=Overview).
|
|
|
|
## Community support
|
|
For general help using ToolJet, please refer to the official [documentation](https://docs.tooljet.com/docs/). For additional help, you can use one of these channels to ask a question:
|
|
|
|
- [Slack](https://tooljet.com/slack) - Discussions with the community and the team.
|
|
- [GitHub](https://github.com/ToolJet/ToolJet/issues) - For bug reports and feature requests.
|
|
- [Twitter](https://twitter.com/ToolJet) - Get the product updates quickly.
|
|
|
|
## Roadmap
|
|
Check out our [roadmap](https://github.com/ToolJet/ToolJet/projects/2) to stay updated on recently released features and learn about what's coming next.
|
|
|
|
## 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](CONTRIBUTING.md) to familiarize yourself with ToolJet's development process, how to suggest bug fixes and improvements, and the steps for building and testing your changes. <br>
|
|
|
|
## Contributors
|
|
<a href="https://github.com/tooljet/tooljet/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=tooljet/tooljet&max=400&columns=20" />
|
|
<img src="https://us-central1-tooljet-hub.cloudfunctions.net/github" width="0" height="0" />
|
|
</a>
|
|
|
|
## License
|
|
ToolJet © 2023, ToolJet Solutions Inc - Released under the GNU Affero General Public License v3.0.
|