Go to file
michael shanks 44e85ef573 bug fixing 2019-09-09 21:02:23 +01:00
.vscode initialise master database working 2019-06-07 12:02:48 +01:00
packages bug fixing 2019-09-09 21:02:23 +01:00
.gitignore refactoring routes to serve app UIs 2019-07-16 22:14:57 +01:00
.gitmodules removed core submodule 2019-07-15 07:12:32 +01:00
AUTHORS.md making OS friendly :) 2019-06-07 12:09:06 +01:00
CONTRIBUTING.md making OS friendly :) 2019-06-07 12:09:06 +01:00
lerna.json refactoring routes to serve app UIs 2019-07-16 22:14:57 +01:00
package.json mono repo 2019-06-07 14:18:10 +01:00
readme.md bug fixing 2019-09-09 21:02:23 +01:00

readme.md

Getting Started

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

For node gyp on windows

npm install --global --production windows-build-tools and this might help: https://github.com/nodejs/node-gyp/issues/1278

For node gyp on ubuntu

sudo apt-get install build-essentials

Once you have this, try...

npm install

Next, run the tests. Install jest, globally:

npm install -g jest

And finally, run

jest

Documentation

A work in progress, lives here: https://github.com/Budibase/docs/blob/master/budibase-core.md