A boilerplate for Ruby on Rails Blogs.
">https://lh6.googleusercontent.com/-J4_ttNHnWZo/U5IivU_0-XI/AAAAAAAAEIg/XikKjaSdReU/w1320-h986-no/Screenshot+2014-06-06+16.20.41.png)-->- Prerequisites
- Getting Started
- Project Structure
- List of Packages
- Posts
- Admin
- Useful Tools and Resources
- How It Works
- Changelog
- Contributing
- License
- Postgresql
- Ruby
- Rails
- Command Line Tools
❗ Note: If you are new to Ruby on Rails, I recommend to watch
The easiest way to get started is to clone the repository:
You must also have a postgres server running in the background! If you are using a mac, you just need to start the postgres app. Otherwise you can also run the --- command from terminal
# Get the latest snapshot
git clone --depth=1 https://github.com/pramodsum/blog_template.git myproject
cd myproject
# Install rails packages
bundle install
rails s❗ Note: I highly recommend installing Guard and LiveReload.
It watches for any changes in your rails app and automatically restarts the
server. Once installed, instead of node app.js use guard. It will
save you a lot of time in the long run, because you won't need to manually
restart the server each time you make a small change in code.
| Package | Description |
|---|---|
| rails | Full-stack web framework optimized for programmer happiness and sustainable productivity |
| pg | Ruby interface to Postgresql |
| sass-rails | Sass adapter for the Rails asset pipeline |
| uglifier | Minifies JavaScript files by wrapping UglifyJS to be accessible in Ruby |
| coffee-rails | CoffeeScript adapter for the Rails asset pipeline |
| jquery-rails | Provides jQuery and the jQuery-ujs driver for your Rails 3+ application |
| turbolinks | Makes following links in your web application faster (use with Rails Asset Pipeline) |
| jbuilder | Create JSON structures via a Builder-style DSL |
| sdoc | rdoc generator html with javascript search index |
| spring | Rails application preloader |
| zurb-foundation | ZURB Foundation on Sass/Compass |
| bootstrap-sass | Twitter's Bootstrap, converted to Sass and ready to drop into Rails or Compass |
| autoprefixer-rails | Parse CSS and add vendor prefixes to CSS rules using values from the Can I Use website |
| guard-rails | Restart Rails when things change in your app |
| rails_12factor | Run Rails the 12factor way |
| rails_serve_static_assets | Force Rails to serve static assets |
| polyamorous | Extends ActiveRecord's associations to support polymorphic belongs_to associations |
| ransack | Successor to the MetaSearch gem |
| formtastic | Form builder plugin/gem with semantically rich and accessible markup |
| devise | Flexible authentication solution for Rails with Warden |
| activeadmin | The administration framework for Ruby on Rails |
| sprockets | Rack-based asset packaging system that concatenates and serves JavaScript, CoffeeScript, CSS, LESS, Sass, and SCSS |
| redcarpet | A fast, safe and extensible Markdown to (X)HTML parser |
| rouge | Simple, easy-to-extend drop-in replacement for pygments. |
| ionicons-rails | Ionicons for Ruby on Rails |
The following tools and resource recommendations were taken from the Hackathon Starter Project
- JSDB.io - The Database of JavaScript Libraries
- JS Recipes - JavaScript tutorials for backend and frontend development.
- JavascriptOO - A directory of JavaScript libraries with examples, CDN links, statistics, and videos.
- Favicon Generator - Generate favicons for PC, Android, iOS, Windows 8.
- Code Guide - Standards for developing flexible, durable, and sustainable HTML and CSS.
- Bootsnipp - Code snippets for Bootstrap.
- UIBox - Curated HTML, CSS, JS, UI components.
- Bootstrap Zero - Free Bootstrap templates themes.
- Google Bootstrap - Google-styled theme for Bootstrap.
- Font Awesome Icons - It's already part of the Hackathon Starter, so use this page as a reference.
- Colors - A nicer color palette for the web.
- Creative Button Styles - awesome button styles.
- Creative Link Effects - Beautiful link effects in CSS.
- Medium Scroll Effect - Fade in/out header background image as you scroll.
- GeoPattern - SVG background pattern generator.
- Trianglify - SVG low-poly background pattern generator.
- Framework7 - Full Featured HTML Framework For Building iOS7 Apps.
- InstantClick - Makes your pages load instantly by pre-loading them on mouse hover.
- NProgress.js - Slim progress bars like on YouTube and Medium.
- Hover - Awesome CSS3 animations on mouse hover.
- Magnific Popup - Responsive jQuery Lightbox Plugin.
- jQuery Raty - Star Rating Plugin.
- Headroom.js - Hide your header until you need it.
- X-editable - Edit form elements inline.
- Offline.js - Detect when user's internet connection goes offline.
- Alertify.js - Sweet looking alerts and browser dialogs.
- selectize.js - Styleable select elements and input tags.
- drop.js - Powerful Javascript and CSS library for creating dropdowns and other floating displays.
- scrollReveal.js - Declarative on-scroll reveal animations.
Generalizing style template for blog
- Added post calendar to footer
- Added top 5 recent posts to footer
Initial upload of project!
If something is unclear, confusing, or needs to be refactored, please let me know. Pull requests are always welcome, but due to the opinionated nature of this project, I cannot accept every pull request. Please open an issue before submitting a pull request.
The MIT License (MIT)
Copyright (c) 2014 Sumedha Pramod
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.