Skip to content

Latest commit

 

History

History
85 lines (52 loc) · 3.36 KB

README.md

File metadata and controls

85 lines (52 loc) · 3.36 KB

Infopark Kickstarter

Gem Version Code Climate Dependency Status

Infopark Kickstarter provides generators and rake tasks to quickly setup or enhance an Infopark Ruby on Rails project. All generated code represents a working example, but can be fully customized within the application.

Installation and Usage

Please visit our Dev Center to get the latest installation and usage information.

Testing

There are two types of tests. First there are rspec tests of the Infopark Kickstarter engine. You can run these tests by simply calling:

$ rake spec

There are also integration tests, that can be run by:

$ rake test:integration

In order to run the tests successfully, you need to create a config/local.yml file and put in your test project data. See local.yml.template for what is needed exactly. The integration tests create an entire new application execute rails generate cms:kickstart and run a few other generators and then execute the tests of the newly created application.

Changelog

See Changelog for more details.

Contributing

We would be very happy and thankful if you open new issues in order to further improve Infopark Kickstarter. If you want to go a step further and extend the functionality or fix a problem, you can do so any time by following the steps below.

  1. Signup for a free Infopark account and setup a test CRM and CMS component in the Infopark console.

  2. Fork and clone the Infopark Kickstarter GitHub repository.

     git clone [email protected]:_username_/infopark_kickstarter.git
 cd infopark_kickstarter

  3. We suggest using rbenv. Anyway, compare your local Ruby version with the version given in .ruby-version and install it if necessary.

     ruby --version

  4. Download the configuration files for your Ruby on Rails application from the Infopark console and copy them to your project's config folder.

     config/rails_connector.yml
 config/custom_cloud.yml

  5. Create the bundle and run all test to make sure everything is working before you add your own changes. You find some more details about testing above in the Testing section.

     bundle
 rake spec
 rake test:integration

  6. Create your feature branch and create a pull request for the develop branch. Please take a look at the already existing generators and rake tasks to get an impression of our coding style and the general architecture.

  7. We are using the GitHub Styleguides and would prefer if you could stick to it.

License

Copyright (c) 2009 - 2013 Infopark AG (http://www.infopark.com)

This software can be used and modified under the LGPLv3. Please refer to http://www.gnu.org/licenses/lgpl-3.0.html for the license text.