budibase/packages/core
michael shanks d7eca3b2f4 added core into mono repo 2019-07-15 07:12:52 +01:00
..
.vscode added core into mono repo 2019-07-15 07:12:52 +01:00
src added core into mono repo 2019-07-15 07:12:52 +01:00
test added core into mono repo 2019-07-15 07:12:52 +01:00
.babelrc added core into mono repo 2019-07-15 07:12:52 +01:00
.eslintrc.json added core into mono repo 2019-07-15 07:12:52 +01:00
.gitignore added core into mono repo 2019-07-15 07:12:52 +01:00
.travis.yml added core into mono repo 2019-07-15 07:12:52 +01:00
AUTHORS.md added core into mono repo 2019-07-15 07:12:52 +01:00
CONTRIBUTING.md added core into mono repo 2019-07-15 07:12:52 +01:00
LICENSE added core into mono repo 2019-07-15 07:12:52 +01:00
package-lock.json added core into mono repo 2019-07-15 07:12:52 +01:00
package.json added core into mono repo 2019-07-15 07:12:52 +01:00
q added core into mono repo 2019-07-15 07:12:52 +01:00
readme.md added core into mono repo 2019-07-15 07:12:52 +01:00
rollup.config.js added core into mono repo 2019-07-15 07:12:52 +01:00
yarn.lock added core into mono repo 2019-07-15 07:12:52 +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