2019-09-10 07:01:26 +02:00
|
|
|
## Getting Started for Contributors
|
2019-09-09 22:02:23 +02:00
|
|
|
|
|
|
|
|
Install requires [node-gyp](https://github.com/nodejs/node-gyp), due to a dependancy on [argon2](https://github.com/ranisalt/node-argon2)
|
|
|
|
|
|
2019-09-10 07:01:26 +02:00
|
|
|
### 1. Prerequisites
|
2019-09-09 22:02:23 +02:00
|
|
|
|
2019-09-10 07:01:26 +02:00
|
|
|
*nodegyp - Windows -* `npm install --global --production windows-build-tools`
|
|
|
|
|
if you have problems, this might help: https://github.com/nodejs/node-gyp/issues/1278
|
2019-09-09 22:02:23 +02:00
|
|
|
|
2019-09-10 07:01:26 +02:00
|
|
|
*nodegyp - Ubuntu (same for Mac ?)* `sudo apt-get install build-essentials`
|
2019-09-09 22:02:23 +02:00
|
|
|
|
2019-09-10 07:01:26 +02:00
|
|
|
*yarn -* `npm install -g yarn`
|
2019-09-09 22:02:23 +02:00
|
|
|
|
2019-09-10 07:01:26 +02:00
|
|
|
*lerna -* `npm install -g lerna`
|
2019-09-09 22:02:23 +02:00
|
|
|
|
2019-09-10 07:01:26 +02:00
|
|
|
*jest* - `npm install -g jest`
|
2019-09-09 22:02:23 +02:00
|
|
|
|
2019-09-10 07:01:26 +02:00
|
|
|
### 2. Install and Build
|
2019-09-09 22:02:23 +02:00
|
|
|
|
2019-09-10 07:01:26 +02:00
|
|
|
`lerna bootstrap`
|
|
|
|
|
|
|
|
|
|
`lerna run build`
|
|
|
|
|
|
|
|
|
|
`yarn run initialise-server`
|
2019-09-09 22:02:23 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
2019-09-10 07:01:26 +02:00
|
|
|
A work in progress, lives here: https://github.com/Budibase/docs
|
2019-09-09 22:02:23 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
