/ README.md
README.md
1 <p align="center"> 2 <a href="https://www.budibase.com"> 3 <img alt="Budibase" src="https://res.cloudinary.com/daog6scxm/image/upload/v1696515725/Branding/Assets/Symbol/RGB/Full%20Colour/Budibase_Symbol_RGB_FullColour_cbqvha_1_z5cwq2.svg" width="60" /> 4 </a> 5 </p> 6 <h1 align="center"> 7 Budibase 8 </h1> 9 <h3 align="center"> 10 AI Agents that run your operations 11 </h3> 12 <p align="center"> 13 Budibase is an open-source operations platform that saves engineers 100s of hours building Agents, Apps and Automations, securely. 14 </p> 15 16 <h3 align="center"> 17 🤖 🎨 🚀 18 </h3> 19 <br> 20 21 <p align="center"> 22 <img alt="Budibase agent ui" src="https://res.cloudinary.com/daog6scxm/image/upload/v1775572268/github/Agent_preview.jpg"> 23 </p> 24 25 <p align="center"> 26 <a href="https://github.com/Budibase/budibase/releases"> 27 <img alt="GitHub all releases" src="https://img.shields.io/github/downloads/Budibase/budibase/total"> 28 </a> 29 <a href="https://github.com/Budibase/budibase/releases"> 30 <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/Budibase/budibase"> 31 </a> 32 <a href="https://twitter.com/intent/follow?screen_name=budibase"> 33 <img src="https://img.shields.io/twitter/follow/budibase?style=social" alt="Follow @budibase" /> 34 </a> 35 <img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Code of conduct" /> 36 <a href="https://codecov.io/gh/Budibase/budibase"> 37 <img src="https://codecov.io/gh/Budibase/budibase/graph/badge.svg?token=E8W2ZFXQOH"/> 38 </a> 39 </p> 40 41 <h3 align="center"> 42 <a href="https://account.budibase.app/register">Get started - we host (Budibase Cloud)</a> 43 <span> · </span> 44 <a href="https://docs.budibase.com/docs/hosting-methods">Get started - you host (Docker, K8s, DO)</a> 45 <span> · </span> 46 <a href="https://docs.budibase.com/docs">Docs</a> 47 <span> · </span> 48 <a href="https://github.com/Budibase/budibase/discussions?discussions_q=category%3AIdeas">Feature request</a> 49 <span> · </span> 50 <a href="https://github.com/Budibase/budibase/issues">Report a bug</a> 51 <span> · </span> 52 Support: <a href="https://github.com/Budibase/budibase/discussions">Discussions</a> 53 </h3> 54 55 <br /><br /> 56 57 ## ✨ Features 58 59 ### Run your operations on one platform 60 61 Handle requests, automate workflows, manage processes, and connect your business systems - without stitching together multiple tools. 62 63 Employees ask questions, request approvals, and report issues every day. Budibase agents understand these requests and handle the work automatically. 64 65 <br /><br /> 66 67 ### Operations your team can run with AI agents 68 69 Employees ask questions, request approvals, and report issues every day. Budibase agents understand these requests and handle the work automatically. 70 71 <p align="center"> 72 <img alt="Budibase chat deploy" src="https://res.cloudinary.com/daog6scxm/image/upload/v1775573887/github/Agent_Chat.jpg"> 73 </p> 74 75 <br /><br /> 76 77 ### Agents that take action 78 79 Budibase agents don’t just answer questions. They run workflows across your business - creating records, routing approvals, updating apps, and notifying teams automatically. 80 81 <p align="center"> 82 <img alt="Budibase agent actions" src="https://res.cloudinary.com/daog6scxm/image/upload/v1775572270/github/Agent_Actions.jpg"> 83 </p> 84 <br /><br /> 85 86 ### Connect the tools your business runs on 87 88 Integrate with databases, AI models, and business apps so agents and automations can take action across your operations. 89 90 ### Deploy with confidence and security 91 92 Budibase is open-source and is made to scale. With Budibase, you can self-host on your own infrastructure and globally manage users, onboarding, SMTP, apps, groups, theming and more. You can also provide users/groups with a portal and disseminate user management to the group manager. 93 94 <br /> 95 96 --- 97 98 <br /> 99 100 ## Budibase Public API 101 102 As with anything that we build in Budibase, our public API is simple to use, flexible, and introduces new extensibility. To summarize, the Budibase API enables: 103 104 - Budibase as a backend 105 - Interoperability 106 107 #### Docs 108 109 You can learn more about the Budibase API at the following places: 110 111 - [General documentation](https://docs.budibase.com/docs/public-api): Learn how to get your API key, how to use spec, and how to use Postman 112 - [Interactive API documentation](https://docs.budibase.com/reference/appcreate) : Learn how to interact with the API 113 114 <br /><br /> 115 116 ## 🏁 Get started 117 118 Deploy Budibase using Docker, Kubernetes, and Digital Ocean on your existing infrastructure. Or use Budibase Cloud if you don't need to self-host and would like to get started quickly. 119 120 ### [Get started with self-hosting Budibase](https://docs.budibase.com/docs/hosting-methods) 121 122 - [Docker - single ARM compatible image](https://docs.budibase.com/docs/docker) 123 - [Docker Compose](https://docs.budibase.com/docs/docker-compose) 124 - [Kubernetes](https://docs.budibase.com/docs/kubernetes-k8s) 125 - [Digital Ocean](https://docs.budibase.com/docs/digitalocean) 126 - [Portainer](https://docs.budibase.com/docs/portainer) 127 128 ### [Get started with Budibase Cloud](https://budibase.com) 129 130 <br /><br /> 131 132 ## 🎓 Learning Budibase 133 134 The Budibase documentation [lives here](https://docs.budibase.com/docs). 135 <br /> 136 137 <br /><br /> 138 139 ## 💬 Community 140 141 If you have a question or would like to talk with other Budibase users and join our community, please hop over to [Github discussions](https://github.com/Budibase/budibase/discussions) 142 143 <br /><br /><br /> 144 145 ## ❗ Code of conduct 146 147 Budibase is dedicated to providing everyone a welcoming, diverse, and harassment-free experience. We expect everyone in the Budibase community to abide by our [**Code of Conduct**](https://github.com/Budibase/budibase/blob/HEAD/docs/CODE_OF_CONDUCT.md). Please read it. 148 <br /> 149 150 <br /><br /> 151 152 ## 🙌 Contributing to Budibase 153 154 From opening a bug report to creating a pull request: every contribution is appreciated and welcomed. If you're planning to implement a new feature or change the API, please create an issue first. This way, we can ensure your work is not in vain. 155 Environment setup instructions are available [here](https://github.com/Budibase/budibase/tree/HEAD/docs/CONTRIBUTING.md). 156 157 ### Not Sure Where to Start? 158 159 A good place to start contributing is by looking for the [good first issue](https://github.com/Budibase/budibase/labels/good%20first%20issue) tag. 160 161 ### How the repository is organized 162 163 Budibase is a monorepo managed by lerna. Lerna manages the building and publishing of the budibase packages. At a high level, here are the packages that make up Budibase. 164 165 - [packages/builder](https://github.com/Budibase/budibase/tree/HEAD/packages/builder) - contains code for the budibase builder client-side svelte application. 166 167 - [packages/client](https://github.com/Budibase/budibase/tree/HEAD/packages/client) - A module that runs in the browser responsible for reading JSON definition and creating living, breathing web apps from it. 168 169 - [packages/server](https://github.com/Budibase/budibase/tree/HEAD/packages/server) - The budibase server. This Koa app is responsible for serving the JS for the builder and budibase apps, as well as providing the API for interaction with the database and file system. 170 171 For more information, see [CONTRIBUTING.md](https://github.com/Budibase/budibase/blob/HEAD/docs/CONTRIBUTING.md) 172 173 <br /><br /> 174 175 ## 📝 License 176 177 Budibase is open-source, licensed as [GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html). The client and component libraries are licensed as [MPL](https://directory.fsf.org/wiki/License:MPL-2.0) - so the apps you build can be licensed however you like. Budibase paid features are licensed under the [Business Source License](https://github.com/Budibase/budibase/blob/master/packages/pro/license.md), 178 179 <br /><br /> 180 181 ## ⭐ Stargazers over time 182 183 [](https://starchart.cc/Budibase/budibase) 184 185 If you are having issues between updates of the builder, please use the guide [here](https://github.com/Budibase/budibase/blob/HEAD/docs/CONTRIBUTING.md#troubleshooting) to clear down your environment. 186 187 <br /><br /> 188 189 ## Contributors ✨ 190 191 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): 192 193 <a href="https://github.com/Budibase/budibase/graphs/contributors"> 194 <img src="https://contrib.rocks/image?repo=Budibase/budibase" /> 195 </a> 196 197 Made with [contrib.rocks](https://contrib.rocks).