https://github.com/securingsincity/chrome-calamari

https://github.com/securingsincity/chrome-calamari

Last synced: about 12 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/securingsincity/chrome-calamari
• Owner: securingsincity
• Created: 2015-10-09T15:45:42.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-10-09T16:30:19.000Z (about 9 years ago)
• Last Synced: 2024-11-08T02:10:14.233Z (about 2 months ago)
• Language: JavaScript
• Size: 633 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Calamari

A chrome extension to handle bulk merging on milestones. 

![screenshot](https://raw.githubusercontent.com/securingsincity/chrome-calamari/master/artworks/Screenshot_640x400.png)

## Installation

	$ npm install

## Usage

* Get an access token from your account's token page https://github.com/settings/tokens

* Add that access token to the config.js 

* If you are using github enterprise you will need to modify the config page as well the manifest to match the url path

* Run `$ gulp --watch` and load the `dist`-directory into chrome.

## Entryfiles (bundles)

There are two kinds of entryfiles that create bundles.

1. All js-files in the root of the `./app/scripts` directory

2. All css-,scss- and less-files in the root of the `./app/styles` directory

## Tasks

### Build

	$ gulp

| Option         | Description                                                                                                                                       |

|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------|

| `--watch`      | Starts a livereload server and watches all assets. To reload the extension on change include `chromereload.js` or `livereload.js` in your bundle. |

| `--production` | Minifies all assets                                                                                                                               |

| `--verbose`    | Log additional data to the console.            

### compress

Zips your `dist` directory and saves it in the `packages` directory.

    $ gulp compress

### Version

Increments version number of `manifest.json` and `package.json`, 

commits the change to git and adds a git tag.

    $ gulp patch      // => 0.0.X

 

or 

    $ gulp feature    // => 0.X.0

or 

    $ gulp release    // => X.0.0

## Globals

The build tool also defines a variable named `ENV` in your scripts. It will be set to `development` unless you use the `--production` option.

**Example:** `./app/background.js`

	if(ENV === 'development'){

		console.log('We are in development mode!');

	}