Go to file
Martin McKeaveney 8a3d736fe2 Update release.yml 2020-05-15 14:39:27 +01:00
.github/workflows Update release.yml 2020-05-15 14:39:27 +01:00
.vscode fixes for getting started... 2019-11-09 08:14:10 +00:00
packages Making budibase downloadable, configuring CI to build executable bina… (#233) 2020-05-14 21:18:36 +01:00
scripts allow bb home folder to bem anywhere 2020-05-11 15:42:42 +01:00
.DS_Store client lib tests 2020-05-07 13:33:25 +01:00
.eslintrc.json eslint tidy up 2020-02-25 15:46:04 +00:00
.gitignore wip: move components to node_modules folder for easier importing 2020-03-31 11:50:13 +02:00
.gitmodules removed core submodule 2019-07-15 07:12:32 +01:00
.prettierignore eslint tidy up 2020-02-25 15:46:04 +00:00
.prettierrc include svelte files in prettier 2020-02-03 09:50:30 +00:00
AUTHORS.md Update AUTHORS.md 2020-01-23 09:26:57 +00:00
CONTRIBUTING.md updates 2020-05-13 15:38:51 +01:00
lerna.json v0.0.32 2020-04-06 09:26:13 +01:00
package.json server initialisation & run fixed 2020-05-11 14:50:15 +01:00
readme.md adding developer docs 2020-05-13 15:30:15 +01:00
yarn.lock Component Panel - root level components display 2020-04-17 10:26:48 +01:00

readme.md

Getting Started with Budibase

(For contributors - scroll down)

1. Global install budibase

npm install -g budibase

2. 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

Documentation

A work in progress, lives here: https://docs.budibase.com