No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
client-gen
extension
src
test
.gitignore
.nvmrc
.travis.yml
README.md
bower.json
gulpfile.js
package.json

README.md

Clearnexus - Chrome Extension

Build Status

Set Up

Clone the repository with git:

$ git git@github.com:stackbuilders/clearnexus-chrome-extension.git

Install dependencies:

$ npm install
$ bower install

Build extension

Init configuration

Go to /src/Config.purs and change the url attribute of the config records according to your development, staging (testing) or production servers. For example:

staging :: Config
staging = Config {
  url: <"YOUR STAGING SERVER URL HERE">
  }

Go to /src/Main.purs and change the name of the environment variable according to the environment in which you want to build the extension. There are only three possible values, namely, production, development, staging, with default in production. Take into account that this variable will determine which config record in Config.purs will be picked to build the extension:

environment :: String
environment = <"production or development or staging">

Modify the extension/manifest.json file permissions if necessary. For example, it may be that in your development environment you want to run the extension with a tuneling service like ngrok. Thus, you have to give permissions to the ngrok-url in the following way:

{
 ...,

 "permissions": [
	"activeTab",
	"tabs",
	"storage",
	"*://staging.clearnex.us/*",
	"*://ca639050.ngrok.io/*" --> EXAMPLE NGROK URL
	]
}

Make sure that the clearnexus server url you provide is forwarded against https. Otherwise, you may have problems when the extension executes the ajax requests.

Build

To build the extension for testing in development environment:

$ pulp browserify --to extension/clearnexus.js

To package the extension for production:

$ gulp build

You can find the extension in dist/clearnexus.zip

Run

Development

Open your Google Chrome web browser and go to extensions. Enable Developer mode and choose the option Load unpacked extension.... Load the directory: clearnexus-chrome-extension/extension. And use the extension in a Gmail session.

Production

Open your Google Chrome web browser and go to extensions. Drag and drop dist/clearnexus.zip file to install the extension. And use the extension in a Gmail session.

Running tests

Set this environment variable (you can find sample values in access_tokens table):

CLEARNEXUS_USER_TEST_TOKEN

Run pulp test