Go to file

Michael Shanks 34b957f331 Builder saves backend and front end seperately (#88 ) * refactoring server for screens & page layout restructure * Disable API calls, UI placeholders. * buildPropsHierarchy is gone & screen has url * Recent changes. * router * router * updated git-ignore to reinclude server/utilities/builder * modified cli - budi new create new file structure * Fix uuid import. * prettier fixes * prettier fixes * prettier fixes * page/screen restructure.. broken tests * all tests passing at last * screen routing tests * Working screen editor and preview. * Render page previews to the screen. * Key input lists to ensure new array references when updating styles. * Ensure the iframe html and body fills the container. * Save screens via the API. * Get all save APIs almost working. * Write pages.json to disk. * Use correct API endpoint for saving styles. * Differentiate between saving properties of screens and pages. * Add required fields to default pages layouts. * Add _css default property to newly created screens. * Add default code property. * page layout / screens - app output * backend and fronend save seperately Co-authored-by: pngwn <pnda007@gmail.com>		2020-02-10 21:35:51 +00:00
.github/workflows	ci setup complete	2020-01-31 14:25:53 +00:00
.vscode	fixes for getting started...	2019-11-09 08:14:10 +00:00
packages	Builder saves backend and front end seperately (#88 )	2020-02-10 21:35:51 +00:00
.eslintrc.json	running prettier over codebase, removing merge files	2020-02-03 09:24:25 +00:00
.gitignore	Update gitignored files.	2020-01-24 14:51:28 +00:00
.gitmodules	removed core submodule	2019-07-15 07:12:32 +01: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	making OS friendly :)	2019-06-07 12:09:06 +01:00
lerna.json	v0.0.16	2020-01-23 11:38:11 +00:00
package.json	include svelte files in prettier	2020-02-03 09:50:30 +00:00
readme.md	Update readme.md	2020-01-29 09:11:33 +00:00
yarn.lock	include svelte files in prettier	2020-02-03 09:50:30 +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

Getting Started for Contributors

1. Prerequisites

yarn - npm install -g yarn

jest - npm install -g jest

2. Clone this repository

git clone https://github.com/Budibase/budibase.git

then cd into your local copy...

3. Install and Build

yarn to install project dependencies

yarn bootstrap will install all budibase modules

yarn build will build all budibase packages

yarn initialise will initialise your budibase (i.e. create local database)

4. Running

A Budibase apps folder will have been created in packages/server/myapps. This is a blank apps folder, so you will need to create yourself an app:

cd packages/server
yarn run budi new your-app-name

then

yarn run budi and to run the budibase server

if you then want to run the builder in dev mode (i.e. with hot reloading):

... keep the server running, and..

Open a new console
yarn dev
Access the builder on http://localhost:3000

This will enable watch mode for both the client AND the server.

Running Commands from /server Directory

Notice that when inside packages/server, you can use any Budibase CLI command via yarn:

e.g. yarn budi new mikes_app == budi new mikes_app

This will use the CLI directly from packages/cli, rather than your globally installed budi

Documentation

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