DEVELOPER_README.md

Make a Contribution

So you want to contribute to BUILD? Good choice! There is lots of scope for contribution, and there's plenty to do! Popular contributions include bug reports, feature requests, and new features. This document describes how to make contributions to any of these modules.

##Getting Started

###Prerequisites

• install GIT
• install npm.js - only version 1.4.28 is supported
• install node.js -versions 10.33 and 10.38 are supported
• install mongodb -only version 2.6.x is supported
• Follow install for your OS @ https://github.com/TooTallNate/node-gyp/blob/master/README.md#installation

###Download / Clone

1. Clone BUILD repo

   git clone https://github.com/SAP/BUILD.git

2. Install required node modules (dependencies) (note, you need to be in the BUILD/ folder within the repo):

   npm install -g grunt-cli
   cd BUILD/BUILD/
   npm install

3. Initialize the database(Required just the first time):

    cd server
    node initSchema.js
    node setDefaultAccess.js
    cd ..

4. Start the BUILD application (for Dev):

    grunt serve

Go to http://localhost:9000 in Chrome browser and click Join

####Admin Settings You can manage your user settings with the Admin module. Install the Admin module here: http://github.com/sapbuild/Admin. You can log in to the Admin module using your BUILD account details.

####Debugging the Node.js backend Starting BUILD with "grunt serve" will start the debug server on the default port 5858. You can connect to this debugger session with tools like Webstorm or node-inspector. The easiest and fastest way to debug the Node.js backend is to use node-inspector. You can install node-inspector globally via:

npm install -g node-inspector

and connect then to the running server via

node-inspector --no-preload

The option --no-preload will speed up the initiliziation dramatically as it doesn't preload all source files, but loads them when neccessary.

#Contact

Having a problem? Create a bug or ask a question using the BUILD Issue Tracker, send a mail to [email protected] or send a tweet to our twitter account buildwithbuild and we'll get back to you as soon as possible.

Modules in Build

Foundation Modules

• angular-sap-common-directives
• angular-sap-common-services
• angular-sap-ui-elements
• node-sap-mongo-config
• node-sap-common
• node-sap-app-server
• node-sap-mailer
• node-sap-secure-store
• node-sap-upload
• node-sap-mongo
• node-sap-promise
• node-sap-logging
• node-sap-upload
• node-sap-mongo-config
• node-sap-build

Build Modules

• PrototypeEditors
• BUILD
• Projects
• UICatalogManager
• UserResearch
• BusinessCatalogManager
• Auth
• Shell
• SharedThirdParties
• Common
• AngularZip
• AngularUIGrid
• AngularUITree
• Html2Canvas
• KeyBoardEventPolyfill
• AngularSAPD3Plugins
• jQuery

Admin Modules

• AdminUsers
• Admin
• AdminAudit