nagyistge / ollert Goto Github PK

• Author: Larry Price [email protected]
• Company: Software Engineering Professionals, Inc.
• Website: ollertapp.com
• License: GNU Affero GPL v3.0

Ollert is a data analysis tool for Trello.

Since Ollert depends entirely on Trello for users, Ollert will support only browsers supported by Trello. Trello officially supports the following browsers:

• Chrome - Current stable release
• Safari - Version 6.0 or higher
• Firefox - Current stable release
• Internet Explorer - Version 10.0 or higher

You almost certainly want to be using a Unix-based operating system. Some dependencies will be necessary before you can run the application. On Ubuntu:

# sudo apt-get install libxslt-dev libxml2-dev build-essential libqtwebkit-dev

Note: You may need more packages. If you do, please edit this document and add them to the command above.

Requirements

• ruby-2.3.1 - Install using RVM, be aware of this issue
• mongodb - Check out this very helpful page
• bundler - gem install bundler
• npm - sudo apt-get install nodejs npm

In the project root folder, you should:

• bundle install
  • Installs the required ruby gems
• npm install
  • Installs the required node packages
• npm install -g grunt-cli
  • Installs the grunt-cli.

Create a file called .env in the root project folder. The format of the .env file is simply:

ENVIRONMENT_VARIABLE=This is the value
ANOTHER_VARIABLE=Another value

Environment variables:

• PUBLIC_KEY
  • required
  • Retrieve a public key from Trello by visiting https://trello.com/1/appKey/generate
• TRELLO_TEST_DISPLAY_NAME
  • required
  • Display name to use while running cukes (this is your @<username> from Trello)
• TRELLO_TEST_USERNAME
  • required
  • Username to use while running cukes
• TRELLO_TEST_PASSWORD
  • required
  • Password to use while running cukes
• MEMBER_TOKEN
  • required
  • this value is used to run the integration tests. To generate this value after you have entered your PUBLIC_KEY run the following command and paste the result into your .env file where it asks you to: rake test:setup
• SESSION_SECRET
  • optional
  • Any string
• RACK_ENV
  • optional
  • You should set this to development. Other options include testing and production.

Run rake to start the application on localhost:4000. This will fork two processes: a rack server (probably unicorn) and grunt watch (to constantly compile and minify Sass and javascript files).

All tests must pass before pushing to origin/master.

All changes checked in to origin/master must be tested. There are two types of test: spec (unit tests) and cukes (acceptance tests).

To run the spec tests, use rake test:spec.

To run the cukes, use rake test:cukes. Cukes are run using the TRELLO_TEST_USERNAME. At least one test will fail if you have the improper boards. Create an organization "Test Organization 1" on Trello. Under "Test Organization", create two boards: "Test Board #1" and "Test Board #2". Additionally, create a general board called "Empty Board" and verify that the default "Welcome Board" is still visible to you. If "Welcome Board" is no longer available, you can simply create a new "Welcome Board" without any organization.

To run all tests, use rake test:all.

The JavaScript specs use testem as the test runner. By default the tests will try to use PhantomJS as the browser for the JavaScript specs. To install, PhantomJS needs to be part of your path. To install using Homebrew on OSX run the following command:

brew install phantomjs

Travis CI is being used for CI. For clones of this repository, builds will run in your https://travis-ci.org/<your username>/ollert environment. Since the tests depend on the environment variables mentioned above, those also need to be carried over in your individual Travis CI setup. Please look at the documentation for environment variables for more information about setting up your environment variables.

We want your help! Check out CONTRIBUTING.md for advice on making contributions.