Rails Base App is a base Rails application template for start new Rails-based apps. It's based on Rails 5 and Ruby 2.3.0., MySQL as database and Puma as application server.It has a basic set of gems I usually use in most projects I work. Also it has scaffold templates with this gems integrated to fast and easy build "ready-to-use" CRUD's.
A list of all gems included in this template proyect separated by enviroment.
- uglifier Ruby wrapper for UglifyJS JavaScript compressor.
- turbolinks Turbolinks makes navigating your web application faster.
- nprogress-rails Ruby gem for asset pipeline which includes the version 0.2.0 of the rstacruz' nprogress library.
- rails-assets-jquery jquery for Rails from rails-assets.
- rails-assets-jquery-ujs Ruby on Rails unobtrusive scripting adapter for jQuery from rails-assets.
- rails-assets-select2 Integrate Select2 javascript library with Rails asset pipeline select2 from rails-assets.
- sass-rails Ruby on Rails stylesheet engine for Sass (Dependency for bootstrap-sass gem).
- bootstrap-sass Official Sass port of Bootstrap 2 and 3.
- kaminary A Scope & Engine based, clean, powerful, customizable and sophisticated paginator for Ruby webapps.
- ransack Object-based searching.
- responders A set of Rails responders to dry up your application.
- simple-form Forms made easy for Rails! It's tied to a simple DSL, with no opinion on markup.
- config Easiest way to add multi-environment yaml settings to Rails.
- rails-erd Generate Entity-Relationship Diagrams for Rails applications.
- better_errors Better error page for Rack apps.
- binding_of_caller Retrieve the binding of a method's caller in MRI 1.9.2+.
- web-console Rails Console on the Browser.
- listen The Listen gem listens to file modifications and notifies you about the changes.
- spring Rails application preloader.
- spring-watcher-listen Make Spring watch the filesystem for changes using Listen.
- factory_girl_rails Rails integration for factory_girl.
- rspec-rails Testing framework for Rails 3.x, 4.x and 5.0.
- nyan-cat-formatter Nyan Cat inspired RSpec formatter.
- shoulda-matchers Collection of testing matchers extracted from Shoulda.
- database_cleaner Strategies for cleaning databases in Ruby. Can be used to ensure a clean state for testing.
- faker A library for generating fake data such as names, addresses, and phone numbers.
This project has predefined generators templates for CRUD views and controllers. If you run a scaffold it would use those templates to generate the views and controllers with an specific layout.
You can customize these templates modiffing the files in
lib/templates.
Clone this project as a new project with original repository named "rails-base-app" and set your own project name.
$ git clone git@github.com:cunib/rails-base-app.git --origin rails-base-app [MY-NEW-PROJECT]
Move to [MY-NEW-PROYECT] folder. Change or delete README.md content
$ cd [MY-NEW-PROYECT]
Create your new repo on your GitHub and push master into it. Make sure master branch is tracking origin repo.
$ git remote add origin git@github.com:[MY-GITHUB-ACCOUNT]/[MY-NEW-PROJECT].git
$ git push -u origin master
Find and replace all ocurrencies of "rails-base-app" with an appropriate name for your app.
$ grep -ri rails-base-app
Open database.yml file and change user and password database attributes. Also you can change the database name for de app.
Run rake db:create db:migrate command to create and migrate the database.
Run rails server access localhost:3000 in your browser and...voilá!!. You are done.
You can contribute updating gems or documentation following the "fork-and-pull" Git workflow.
- Fork the repo on GitHub.
- Clone the project to your own machine.
- Commit changes to your own branch.
- Push your work back up to your fork.
- Submit a Pull request so that we can review your changes.
rails-base-app was created and is maintained by Hugo Barreña.
A Railsear con Hugo!.