MirrorSave
/
budibase
mirror of https://github.com/Budibase/budibase.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
123 Commits 116 Branches 2,970 Tags 946 MiB
TypeScript 46.9%
Svelte 33.9%
JavaScript 17.5%
Shell 0.8%
Handlebars 0.4%
Other 0.3%
Go to file
Michael Shanks fb8f22386b Merge branch 'master' of github.com:Budibase/budibase 2019-09-23 06:08:16 +01:00
.vscode initialise master database working 2019-06-07 12:02:48 +01:00
packages Merge branch 'master' of github.com:Budibase/budibase 2019-09-23 06:08:16 +01:00
.gitignore packaging stuff 2019-09-10 06:00:19 +01:00
.gitmodules removed core submodule 2019-07-15 07:12:32 +01:00
AUTHORS.md state event handlers - API 2019-09-23 06:08:06 +01:00
CONTRIBUTING.md making OS friendly :) 2019-06-07 12:09:06 +01:00
lerna.json v0.0.3 2019-09-10 13:07:35 +01:00
package-lock.json css guff 2019-09-23 01:04:30 +01:00
package.json css guff 2019-09-23 01:04:30 +01:00
readme.md Update readme.md 2019-09-23 00:00:48 +01:00

readme.md

Getting Started for Contributors

Install requires node-gyp, due to a dependancy on argon2

1. Prerequisites

nodegyp - Windows - npm install --global --production windows-build-tools if you have problems, this might help: https://github.com/nodejs/node-gyp/issues/1278

nodegyp - Ubuntu (same for Mac ?) sudo apt-get install build-essentials

yarn - npm install -g yarn

lerna - npm install -g lerna

jest - npm install -g jest

2. Clone this repository

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

then cd into your local copy...

3. Install and Build

lerna bootstrap will install all modules

lerna run build will build all packages

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

4. Running

lerna run dev:builder - will run up the builder and server together - i.e. when you want to do some work on the builder

Documentation

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