diff --git a/readme.md b/readme.md index a08dc2b4f6..2b9921e0b1 100644 --- a/readme.md +++ b/readme.md @@ -1,31 +1,33 @@ -## Getting Started +## Getting Started for Contributors Install requires [node-gyp](https://github.com/nodejs/node-gyp), due to a dependancy on [argon2](https://github.com/ranisalt/node-argon2) -### For node gyp on windows +### 1. Prerequisites -`npm install --global --production windows-build-tools` -and this might help: https://github.com/nodejs/node-gyp/issues/1278 +*nodegyp - Windows -* `npm install --global --production windows-build-tools` +if you have problems, this might help: https://github.com/nodejs/node-gyp/issues/1278 -### For node gyp on ubuntu +*nodegyp - Ubuntu (same for Mac ?)* `sudo apt-get install build-essentials` -`sudo apt-get install build-essentials` +*yarn -* `npm install -g yarn` -Once you have this, try... +*lerna -* `npm install -g lerna` -`npm install` +*jest* - `npm install -g jest` -Next, run the tests. Install jest, globally: +### 2. Install and Build -`npm install -g jest` +`lerna bootstrap` + +`lerna run build` + +`yarn run initialise-server` -And finally, run -`jest` ## Documentation -A work in progress, lives here: https://github.com/Budibase/docs/blob/master/budibase-core.md +A work in progress, lives here: https://github.com/Budibase/docs