Go to file
michael shanks e3eb15d1e6 instal instructions 2019-09-10 06:01:26 +01:00
.vscode initialise master database working 2019-06-07 12:02:48 +01:00
packages added packages.json to core/dist 2019-09-10 04:37:54 +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 instal instructions 2019-09-10 06:01:26 +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. Install and Build

lerna bootstrap

lerna run build

yarn run initialise-server

Documentation

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