From 5ce1674c31ea8694f6dd554a6d459d73ee81d149 Mon Sep 17 00:00:00 2001 From: Michael Shanks Date: Sat, 12 Oct 2019 08:02:56 +0100 Subject: [PATCH] readme for non-contributors --- readme.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/readme.md b/readme.md index 5fe66f0795..da4d96a5c9 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,45 @@ +Getting Started with Budibase + +### 1. Prerequisites (for nodegyp) + +We will try to make this bit easier, but for now: + +- Windows - https://github.com/nodejs/node-gyp#on-windows +- Ubuntu `sudo apt-get install build-essentials` +- Mac: https://github.com/nodejs/node-gyp#on-macos + +### 2. Global install budibase + +`npm install -g budibase` + +### 3. Start using Budibase + +Create a directory to store your Budibase apps + +`mkdir my-budibase` + +`cd my-budibase` + +Initialise Budibase in current directory + +`budi init` + +Create a new Budibase app + +`budi new my-app` + +Run Budibase + +`budi` + +You can now access the Budibase builder on http://localhost:4001/_builder + +Start building! + +Once you have created your app, you need to create yourself an instance of your app (i.e. a database) + +`budi instance my-app` + ## Getting Started for Contributors Install requires [node-gyp](https://github.com/nodejs/node-gyp), due to a dependancy on [argon2](https://github.com/ranisalt/node-argon2) @@ -5,6 +47,7 @@ Install requires [node-gyp](https://github.com/nodejs/node-gyp), due to a depend ### 1. Prerequisites *nodegyp -* + - Windows - https://github.com/nodejs/node-gyp#on-windows - Ubuntu `sudo apt-get install build-essentials` - Mac: https://github.com/nodejs/node-gyp#on-macos