Skip to content

Instantly share code, notes, and snippets.

@josemarluedke
Last active December 18, 2015 03:38
Show Gist options
  • Select an option

  • Save josemarluedke/5719143 to your computer and use it in GitHub Desktop.

Select an option

Save josemarluedke/5719143 to your computer and use it in GitHub Desktop.
Default README.md file for Rails projects

Project name

Project description...

Development environment

Make sure you have installed Ruby 2.0.0.

Then just checkout the code, configure dependencies and run the tests:

  1. Clone the repository:

git clone git://github.com/josemarluedke/project.git

  1. Install Bundler

gem install bundler

  1. Install all dependencies from Gemspec:

bundler install

  1. Configure the database connection

cp config/database.sample.yml config/database.yml

  1. Create database and talbes

bundle exec rake db:create db:migrate db:seed

Running tests

  1. Prepare the database

    bundle exec rake db:test:prepare

  2. Run the rspec

    bundle exec rspec spec/

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. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

Licensed under the MIT license (see MIT-LICENSE file)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment