2019-10-12 09:14:56 +02:00
|
|
|
# Getting Started with Budibase
|
|
|
|
|
|
|
|
|
|
(For contributors - scroll down)
|
2019-10-12 09:02:56 +02:00
|
|
|
|
2020-01-23 11:52:42 +01:00
|
|
|
### 1. Global install budibase
|
2019-10-12 09:02:56 +02:00
|
|
|
|
|
|
|
|
`npm install -g budibase`
|
|
|
|
|
|
2020-01-23 11:52:42 +01:00
|
|
|
### 2. Start using Budibase
|
2019-10-12 09:02:56 +02:00
|
|
|
|
|
|
|
|
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`
|
|
|
|
|
|
2019-09-09 22:02:23 +02:00
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
2019-09-10 11:38:13 +02:00
|
|
|
A work in progress, lives here: https://docs.budibase.com
|
2019-09-09 22:02:23 +02:00
|
|
|
|
2020-05-18 09:08:33 +02:00
|
|
|
## Contributing
|
2019-09-09 22:02:23 +02:00
|
|
|
|
2020-05-19 17:22:35 +02:00
|
|
|
Contributors, see [CONTRIBUTING.md](./CONTRIBUTING.md)
|
