@budibase/deployment NPM

✨ Features

When other platforms chose the closed source route, we decided to go open source. When other platforms chose cloud builders, we decided a local builder offered the better developer experience. We like to do things differently at Budibase.

Build and ship real software. Unlike other platforms, with Budibase you build and ship single page applications. Budibase applications have performance baked in and can be designed responsively, providing your users with a great experience.
Open source and extensable. Budibase is open-source. The builder is licensed AGPL v3, the server is GPL v3, and the client is MPL. This should fill you with confidence that Budibase will always be around. You can also code against Budibase or fork it and make changes as you please, providing a developer-friendly experience.
Load data or start from scratch. Budibase pulls in data from multiple sources, whether it’s a CSV, an external database (coming very soon), or a REST API. And unlike other platforms, with Budibase you can start from scratch and create business apps with no data sources. Request new data sources.
Design and build apps with powerful pre-made components. Budibase comes out of the box with beautifully designed, powerful components which you can use like building blocks to build your UI. We also expose a lot of your favourite CSS styling options so you can go that extra creative mile. Request new components.
Automate processes, integrate with other tools, and connect to webhooks. Save time by automating manual processes and workflows. From connecting to webhooks, to automating emails, simply tell Budibase what to do and let it work for you. You can easily create new automations for Budibase here or request new integrations here.
Cloud hosting (available) and self-hosting (coming soon). Users will soon have the option to host with Budibase in AWS (available now) or self-host (coming very soon). From the very beginning, we wanted our users to have the option to self-host. We understand the importance of having full control over data. This is why we are working incredibly hard to offer an easy path to self-hosting. If you are interested in self-hosting, please join the conversation and add your thoughts.

⌛ Status

Alpha: We are demoing Budibase to users and receiving feedback
Private Beta: We are testing Budibase with a closed set of customers
Public Beta: Anyone can sign-up and use Budibase but it's not production ready. We cannot ensure backwards compatibility
Official Launch: Production-ready

We are currently in Public Beta. Until our official launch, we cannot ensure backwards compatibility for your Budibase applications between versions. Issues may arise when trying to edit apps created with old versions of the Budibase builder.

Watch "releases" of this repo to get notified of major updates, and give the star button a click whilst you're there.

If you are having issues between updates of the builder, please use the guide here to clear down your environment.

Roadmap

Checkout our Public Roadmap. If you would like to discuss some of the items on the roadmap, please feel to reach out on Discord, or via Github discussions

🏁 Getting Started with Budibase

The Budibase builder runs in Electron, on Mac, PC and Linux. Follow the steps below to get started:

Sign-up to Budibase
Create a username and password
Copy your API key
Download Budibase
Open Budibase and enter your API key

Here is a guided tutorial if you need extra help.

🎓 Learning Budibase

The Budibase documentation lives here.

You can also follow a quick tutorial on how to build a CRM with Budibase

❗ Code of Conduct

Budibase is dedicated to providing a welcoming, diverse, and harrassment-free experience for everyone. We expect everyone in the Budibase community to abide by our Code of Conduct. Please read it.

🙌 Contributing to Budibase

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.

Not Sure Where to Start?

A good place to start contributing, is the First time issues project.

How the repository is organized

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.

packages/builder - contains code for the budibase builder client side svelte application.
packages/client - A module that runs in the browser responsible for reading JSON definition and creating living, breathing web apps from it.
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.

For more information, see CONTRIBUTING.md