diff --git a/README.md b/README.md index ca7299ff7c..05f59d93e7 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,10 @@

- Build custom business tools in minutes and on your own infrastructure + Build internal tools on your own infrastructure in minutes

- Budibase is an open-source low-code platform, helping developers and IT professionals build, automate, and ship custom business apps in minutes and on their own infrastructure. + Budibase is an open-source low-code platform, helping developers and IT professionals build, automate, and ship internal tools on their own infrastructure in minutes.

@@ -58,7 +58,6 @@ ## ✨ 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. @@ -77,6 +76,9 @@ When other platforms chose the closed source route, we decided to go open source

+--- + + ## ⌛ Status - [x] Alpha: We are demoing Budibase to users and receiving feedback - [x] Private Beta: We are testing Budibase with a closed set of customers @@ -96,25 +98,43 @@ Watch "releases" of this repo to get notified of major updates, and give the sta If you are having issues between updates of the builder, please use the guide [here](https://github.com/Budibase/budibase/blob/HEAD/.github/CONTRIBUTING.md#troubleshooting) to clear down your environment. -## 🏁 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](https://portal.budi.live/signup) -- [ ] Create a username and password -- [ ] Copy your API key -- [ ] Download Budibase -- [ ] Open Budibase and enter your API key - -[Here is a guided tutorial](https://docs.budibase.com/tutorial/tutorial-signing-up) if you need extra help. +--- -## 🤖 Self-hosting +## 🏁 Getting Started with Budibase in 5 minutes -Budibase wants to make sure anyone can use the tools we develop and we know a lot of people need to be able to host the apps they make on their own systems - that is why we've decided to try and make self hosting as easy as possible! +To get started, you must have docker and docker compose installed on your machine. +Once you have Docker installed, the process takes 5 minutes, with these four steps: -Currently, you can host your apps using Docker or Digital Ocean. The documentation for self-hosting can be found [here](https://docs.budibase.com/self-hosting/introduction-to-self-hosting). +1. Install the Budibase CLI. -[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/droplets/new?onboarding_origin=marketplace&i=09038e&fleetUuid=bb04f9c8-1de8-4687-b2ae-1d5177a0535b&appId=77729671&type=applications&size=s-4vcpu-8gb®ion=nyc1&refcode=0caaa6085a82&image=budibase-20-04) +``` +$ npm i -g @budibase/cli +``` + + +2. Setup Budibase (select where to store Budibase, and the port to run it on) + +``` +budi hosting --init +``` + + +3. Run Budibase + +``` +budi hosting --start +``` + + +4. Create your admin user + +Enter the email and password for the new admin user. + +Done! You are now ready to build powerful internal tools in minutes. For additional information on how to get started and learn Budibase, visit our [docs](https://docs.budibase.com/getting-started). + + +--- ## 🎓 Learning Budibase @@ -124,6 +144,9 @@ The Budibase [documentation lives here](https://docs.budibase.com). You can also follow a quick tutorial on [how to build a CRM with Budibase](https://docs.budibase.com/tutorial/tutorial-introduction) +--- + + ## Roadmap Checkout our [Public Roadmap](https://github.com/Budibase/budibase/projects/10). If you would like to discuss some of the items on the roadmap, please feel to reach out on [Discord](https://discord.gg/rCYayfe), or via [Github discussions](https://github.com/Budibase/budibase/discussions) @@ -151,10 +174,18 @@ Budibase is a monorepo managed by lerna. Lerna manages the building and publishi For more information, see [CONTRIBUTING.md](https://github.com/Budibase/budibase/blob/HEAD/.github/CONTRIBUTING.md) + +--- + + ## 📝 License Budibase is open-source. The builder is licensed [AGPL v3](https://www.gnu.org/licenses/agpl-3.0.en.html), the server is licensed [GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html), and the client is licensed [MPL](https://directory.fsf.org/wiki/License:MPL-2.0). + +--- + + ## 💬 Get in touch If you have a question or would like to talk with other Budibase users, please hop over to [Github discussions](https://github.com/Budibase/budibase/discussions) or join our Discord server: @@ -164,6 +195,9 @@ If you have a question or would like to talk with other Budibase users, please h ![Discord Shield](https://discordapp.com/api/guilds/733030666647765003/widget.png?style=shield) +--- + + ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):