MirrorSave
/
budibase
mirror of https://github.com/Budibase/budibase.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

instal instructions

This commit is contained in:
michael shanks 2019-09-10 06:01:26 +01:00
parent d03b5dce37
commit e3eb15d1e6
1 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
readme.md
View File

@ -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) 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` *nodegyp - Windows -* `npm install --global --production windows-build-tools`
and this might help: https://github.com/nodejs/node-gyp/issues/1278 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 ## 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