updated readme - getting started
This commit is contained in:
parent
6cb4b93b59
commit
5bdf87afdd
34
readme.md
34
readme.md
|
@ -3,39 +3,7 @@
|
||||||
|
|
||||||
# Getting Started with Budibase
|
# Getting Started with Budibase
|
||||||
|
|
||||||
(For contributors - scroll down)
|
The Budibase builder runs in Electron, on Mac, PC and Linux. [Download the latest release](https://github.com/Budibase/budibase/releases), and start building!
|
||||||
|
|
||||||
### 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
|
## Documentation
|
||||||
|
|
Loading…
Reference in New Issue