Skip to content

A Ruby on Rails base project with Wolox standard defaults

License

Notifications You must be signed in to change notification settings

sebastianveraw/rails-bootstrap

 
 

Repository files navigation

Rails Bootstrap

Gitter [Build Status](Link to CI badge) [Code Climate](Link to CodeClimate GPA badge) [Test Coverage](Link to CodeClimate Test coverage badge)

Kickoff for Rails web applications.

Running local server

Git pre push hook

You can modify the pre-push.sh script to run different scripts before you git push (e.g Rspec, Cucumber). Then you need to run the following:

  > chmod +x pre-push.sh
  > ln -s ../../pre-push.sh .git/hooks/pre-push

You can skip the hook by adding --no-verify to your git push.

Installing Ruby

  • Download and install Rbenv.
  • Download and install Ruby-Build.
  • Install the appropriate Ruby version by running rbenv install [version] where version is the one located in .ruby-version

Installing Rails gems

  • Clone the repository.

  • Install Bundler.

  • Install all the gems included in the project.

      > git clone https://github.com/Wolox/rails-bootstrap.git
      > gem install bundler
      > rbenv rehash
      > bundle

Application Setup

Run ./script/bootstrap app_name where app_name is your application name.

Your app is ready. Happy coding!

Running with Docker

Install Docker Compose and then run:

  > git clone https://github.com/Wolox/internal.git
  > docker-compose up

OSX: Get the IP running boot2docker ip in and enter port 3000 in the browser.

When the servers starts, run the following command in a different console:

  > docker-compose run web rake db:create db:seed

To stop the server run the following command in a different console:

  > docker-compose stop

To see the running process, run the following command in a different console:

  > docker-compose ps

New dependencies should be added to Dockerfile and docker-compose.yml and then run:

  > docker-compose build

Deploy Guide

No deploy configuration yet.

Errbit Configuration

Errbit is used for exception errors report. To complete this configuration setup the following environment variables in your server

  • ERRBIT_API_KEY
  • ERRBIT_HOST

with the credentials located in the errbit application.

Code Climate

Add your code climate token to .travis.yml or docker-compose.yml

Staging Environment

For the staging environment label to work, set the TRELLO_URL environment variable.

SEO Meta Tags

Just add a the meta element to your view.

For example

  = meta title: "My Title", description: "My description", keywords: %w(keyword1 keyword2)

You can read more about it here

PGHero Authentication

Set the following variables in your server.

  PGHERO_USERNAME=username
  PGHERO_PASSWORD=password

Set in your server the `PGHERO

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Run rspec tests (bundle exec rspec spec -fd)
  5. Run scss lint (bundle exec scss-lint app/assets/stylesheets/)
  6. Run rubocop lint (bundle exec rubocop app spec -R)
  7. Push your branch (git push origin my-new-feature)
  8. Create a new Pull Request

About

This project is maintained by Esteban Guido Pintos and it was written by Wolox.

Wolox

License

rails-bootstrap is available under the MIT license.

Copyright (c) 2015 Esteban Guido Pintos <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

About

A Ruby on Rails base project with Wolox standard defaults

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 73.1%
  • HTML 21.6%
  • CSS 3.2%
  • Shell 1.2%
  • CoffeeScript 0.9%