rally-app-builder
Advanced tools
Comparing version 0.5.2 to 0.7.0
@@ -5,12 +5,8 @@ { | ||
"description": "A node module that assists in the building of Rally Apps", | ||
"version": "0.5.2", | ||
"homepage": "https://github.com/RallyApps/rally-app-builder", | ||
"version": "0.7.0", | ||
"homepage": "https://github.com/rallyapps/rally-app-builder", | ||
"repository": { | ||
"type": "git", | ||
"url": "git://github.com/RallyApps/rally-app-builder.git" | ||
"url": "git://github.com/rallyapps/rally-app-builder.git" | ||
}, | ||
"contributors": [{ | ||
"name": "Colin O'Brien", | ||
"email": "cobrien@rallydev.com" | ||
}], | ||
"main": "index", | ||
@@ -29,4 +25,3 @@ "engines": { | ||
"uglify-js": "~2.2.3", | ||
"jshint": "~0.9.1", | ||
"jsdom": "0.6.x" | ||
"jshint": "~0.9.1" | ||
}, | ||
@@ -33,0 +28,0 @@ "devDependencies": { |
108
README.md
@@ -5,25 +5,13 @@ #rally-app-builder | ||
## Usage | ||
## Install | ||
1. Install [Node.js](http://nodejs.org/) | ||
First Install [Node.js](http://nodejs.org/) | ||
2. Create a folder for your new app and change directories into it | ||
Second Install the Rally App Builder Globally | ||
`npm install -g rally-app-builder` | ||
3. Install the Rally App Builder: | ||
If you don't have permission to install it globally you can install it locally like this | ||
* Install globally: | ||
>`npm install -g rally-app-builder` | ||
`npm install rally-app-builder` | ||
* If you don't have permission to install it globally you can install it locally: | ||
>`npm install rally-app-builder` | ||
4. Create your app with `rally-app-builder init [name]` | ||
5. Run `npm install` | ||
* Run `grunt` to compile and build everything | ||
* Run `grunt test` to run jasmine tests | ||
* Run `grunt build` to build the deployable HTML file for running inside Rally | ||
* Run `grunt deploy` to test and deploy your app to Rally | ||
## API | ||
@@ -36,6 +24,9 @@ | ||
init [name] [sdk_version] [server] | ||
Creates a new Rally App project in the working directory | ||
Creates a new Rally App project | ||
build | ||
Builds the current App | ||
clone [organization] [repo] | ||
Creates a new Rally App project in the working directory from an existing GitHub project. | ||
Creates a new Rally App project from an existing GitHub project. | ||
@@ -47,7 +38,14 @@ Options: | ||
## Run Tests | ||
To run the tests: | ||
npm test | ||
## Commands | ||
### init | ||
###init | ||
`rally-app-builder init myNewApp` | ||
Creating a new Rally App is as easy as using init. The init command creates you an App for use inside of Rally. | ||
Creating a new Rally App is as easy as using init. The init command creates you a After init creates your App it will automatically run the build command on it for you. | ||
@@ -62,3 +60,9 @@ The init command takes a few parameters. | ||
### build | ||
Use the build command to compile your App into a single HTML page that can be copy and pasted into a Rally customer html [page](http://www.rallydev.com/custom-html) | ||
Run this command before you check your file into source control or whenever you make a change to your config.json file. | ||
### clone | ||
@@ -71,61 +75,1 @@ `rally-app-builder clone RallyApps StoryBoard` | ||
which apps you are most interested in customizing we take that as input on ways to improve the existing catalog App. | ||
## Rally Deploy Grunt Task | ||
```shell | ||
npm install rally-app-builder | ||
``` | ||
```js | ||
grunt.loadNpmTasks('rally-app-builder'); | ||
``` | ||
### Options | ||
#### server | ||
Type: `string` | ||
Default "rally1.rallydev.com" | ||
#### projectOid | ||
Type: `integer` | ||
This needs to be any valid Project Object ID. You can find this in the URI when logged into Rally | ||
#### deployFile | ||
Type: `string` | ||
Default: "deploy.json" | ||
This file stores the Rally generated Page and App IDs when deploying a new app | ||
#### credentialsFile | ||
Type: `string` | ||
Default: "credentials.json" | ||
This file is by default not checked into source respository and contains the username and password IN CLEAR TEXT to be used in the deploy task | ||
#### tab | ||
Type: `string` | ||
Valid Options: `myhome`, `backlogandschedules` | ||
Default: "myhome" | ||
This is the Rally tab that the newly created app will be placed | ||
#### pageName | ||
Type: `string` | ||
Default: "App Name" | ||
This is the name of the Page on the tab that will be created | ||
#### shared | ||
Type: `string` or `boolean` | ||
Default: "off" | ||
This option will make a newly created page shared on the Workspace. You must be a Workspace Admin to use the `on` option | ||
@@ -6,12 +6,8 @@ { | ||
"sdk": "{{sdk_version}}", | ||
"remote_javascript": [ | ||
], | ||
"javascript": [ | ||
"src/App.js" | ||
"App.js" | ||
], | ||
"remote_css": [ | ||
], | ||
"css": [ | ||
"styles/app.css" | ||
"app.css" | ||
] | ||
} |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
9
0
148032
52
191
71
2
- Removedjsdom@0.6.x
- Removedbindings@1.5.0(transitive)
- Removedcontextify@0.1.15(transitive)
- Removedcssom@0.2.50.3.8(transitive)
- Removedcssstyle@0.2.37(transitive)
- Removeddom-serializer@0.2.2(transitive)
- Removeddomelementtype@1.3.12.3.0(transitive)
- Removeddomhandler@2.4.2(transitive)
- Removeddomutils@1.7.0(transitive)
- Removedentities@1.1.22.2.0(transitive)
- Removedfile-uri-to-path@1.0.0(transitive)
- Removedhtmlparser2@3.10.1(transitive)
- Removedjsdom@0.6.5(transitive)
- Removednan@2.22.0(transitive)
- Removednwmatcher@1.3.9(transitive)
- Removedreadable-stream@3.6.2(transitive)
- Removedsafe-buffer@5.2.1(transitive)
- Removedstring_decoder@1.3.0(transitive)
- Removedutil-deprecate@1.0.2(transitive)