Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pbojinov/generator-bcapi
Yeoman generator to scaffold out Conduit toolbar apps - http://wiki.conduit.com/display/conduitapis/Home
https://github.com/pbojinov/generator-bcapi
Last synced: 5 days ago
JSON representation
Yeoman generator to scaffold out Conduit toolbar apps - http://wiki.conduit.com/display/conduitapis/Home
- Host: GitHub
- URL: https://github.com/pbojinov/generator-bcapi
- Owner: pbojinov
- License: mit
- Created: 2014-07-08T03:16:57.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-11-07T18:45:24.000Z (about 10 years ago)
- Last Synced: 2024-10-12T03:09:04.891Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 260 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-bcapi
> A Yeoman generator that provides boilerplate code to easily create toolbar apps.
Maintainer: [Petar Bojinov](https://github.com/pbojinov)
## Prerequisites
1. Have node.js installed on your computer. See instructions [here](http://nodejs.org/download/)
2. Make sure you have [yo](http://yeoman.io/index.html) installed
npm install -g yo
## Getting Started
1. Install the generator by running
npm install -g generator-bcapi
2. Run the generator
yo bcapi
3. Install required depedencies
npm install
3. Start writing your app :)
## Generators
Available generators:
* [bcapi](#app) (aka [bcapi:app](#app))
* [bcapi:component](#component)
* [bcapi:gadget](#gadget)
* [bcapi:launch](#launch)
**Note: Generators are to be run from the root directory of your app.**
### app
Generates a new toolbar app, generating all the boilerplate you need to get started. The app generator also optionally installs Twitter Bootstrap 3.0 and jQuery (1.10.2)
Example:
yo bcapi
### component
Example:
yo bcapi:component red
Produces three files: `app/red.html`, `app/scripts/red.js`, `app/styles/red.css`
`app/red.html`:
```html
red Launch
```
`app/scripts/red.js`:
```javascript
window.onload = function() {
//some functions omitted for brevity
function initialize() {
window.EBDocumentComplete = function(tabid) {
//the page has loaded!
};
}
initialize();
};
```
### gadget
Example:
yo bcapi:gadget green
Produces three files: `app/green.html`, `app/scripts/green.js`, `app/styles/green.css`
`app/green.html`:
```html
green Gadget
```
`app/scripts/green.js`:
```javascript
window.onload = function() {
var closeButton;
function closeWindow() {
CloseFloatingWindow(); //closes gadget window
}
function initialize() {
closeButton = document.getElementById('closeButton');
closeButton.onclick = closeWindow;
}
initialize();
};
```
### launch
Example:
yo bcapi:launch greenLaunch
Produces three files: `app/greenLaunch.html`, `app/scripts/greenLaunch.js`, `app/styles/greenLaunch.css`
`app/greenLaunch.html`:
```html
greenLaunch Launch
```
`app/scripts/greenLaunch.js`:
```javascript
window.onload = function() {
var closeButton;
function toggleGadget() {
//get the current absolute URL path
var currentAbsPath = (((document.URL).toString()).split('#'))[0]; // the hash is to support chrome HTML components
var APP_PATH = currentAbsPath.substring(0, currentAbsPath.lastIndexOf('/')) + '/';
//use the absolute path, make sure gadget and greenGadget.html are in the same folder!
var url = APP_PATH + 'greenGadget.html';
var width = 100;
var height = 300;
var features = 'resizable=no, scrollbars=no, titlebar=no, savelocation=no, saveresizedsize=no, closeonexternalclick=yes, openposition=alignment:(B,R)';
LaunchGadget(url, width, height, features);
}
function initialize() {
closeButton = document.getElementById('close');
closeButton.onclick = toggleGadget;
}
initialize();
};
```
## Structure
The basic structure of the project is given in the following way:
```
├── app/
│ └── scripts/
│ └── styles/
│ └── assets/
├── dist/
│ └── Apps/
├── .editorconfig
├── .jshintrc
├── favicon.ico
├── Gruntfile.js
└── package.json
```
## BCAPI Documentation
[BCAPI Documentation](http://wiki.toolmx.com/display/conduitapis/Home)
## License
[MIT License](http://zenorocha.mit-license.org/)