Skip to content

Latest commit

 

History

History
103 lines (78 loc) · 3.56 KB

README.md

File metadata and controls

103 lines (78 loc) · 3.56 KB
Raw

CF-Console

CF-Console is an easy-to-use web-based interface for your Cloud Foundry instances.

Continuous Integration

Build Status

Demo

Check CF-Console at cloudfoundry.com.

Deploy to CloudFoundry

git clone git://github.com/frodenas/cf-console.git
cd cf-console
bundle
bundle exec rake assets:precompile
vmc push --runtime ruby19
# press Enter for all defaults

Installation

No DB required, just clone the project and start the server:

  • git clone git://github.com/frodenas/cf-console.git
  • bundle install
  • thin start <- It must be an app server with EventMachine and Ruby 1.9 support (e.g. Thin or Rainbows!)

If you plan to deploy this app to a production environment:

  • Set your brand details and Cloud Foundry providers at /config/configatron/defaults.rb
  • Insert your Google Analytics Web Property ID (UA-XXXXX-X) at /app/assets/javascripts/application.js
  • Change the secret token at /config/initializers/secret_token.rb
  • Remove "= render "layouts/forkapp"" at /app/views/layouts/application.html.haml
  • precompile the assets -> RAILS_ENV=production rake assets:precompile
  • enable "config.middleware" option at /config/application.rb to enable async http calls

Testing

In order to test the application, a suite of RSpec tests are provided. You don't need to have a Cloud Foundry instance running in order to pass the tests, as pre-recorded HTTP interactions are also provided thanks to VCR.

So just type:

rake spec

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

  • by using alpha, beta, and prerelease versions
  • by reporting bugs
  • by suggesting new features
  • by writing or editing documentation
  • by writing specifications
  • by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
  • by refactoring code
  • by closing issues
  • by reviewing patches

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issue by voting it up. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

  1. Fork the project.
  2. Create a topic branch.
  3. Implement your feature or bug fix.
  4. Add specs for your feature or bug fix.
  5. Run rake spec. If your changes are not 100% covered, go back to step 4.
  6. Commit and push your changes.
  7. Submit a pull request.

Authors

By Ferran Rodenas [email protected]

Copyright

See LICENSE for details. Copyright (c) 2011 Ferran Rodenas.