budibase/packages/cli
Martin McKeaveney 8177bc0817 model creation and fetching with tests 2020-04-15 15:25:10 +01:00
..
.vscode Lots of poking around to get apps to run, plux fixing tests (#92) 2020-02-12 12:45:24 +00:00
bin model creation and fetching with tests 2020-04-15 15:25:10 +01:00
src bugfix... new apps had incorrect appDefinition.json 2020-03-24 15:33:31 +00:00
.gitignore wip: move components to node_modules folder for easier importing 2020-03-31 11:50:13 +02:00
.npmignore prep for NPM publish 2020-02-26 22:18:14 +00:00
LICENSE CLI nearly there 2019-10-11 17:14:23 +01:00
package.json publish 2020-04-06 09:30:58 +01:00
readme.md fix cli docs 2020-01-23 10:54:33 +00:00
yarn.lock Getting started for contributors fixed - see readme 2019-11-23 07:28:24 +00: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

Running the cli on dev

If you want to test this on dev, from the mono repo, run npm link from here first.

If you use VS Code, open it in this directory, and you will find launch configurations for each command - debugging, yay!