/quickrails5

Primary LanguageRubyMIT LicenseMIT

Quickrails5 Build Status

Rails 5 boilerplate with postgresql and webpack

Features

Current Features

  • User Authentication with Devise
  • Styling
    • Bootstrap v4

Upcoming Features

  • User Authentication with
    • Google
    • Facebook
    • Twitter
  • Code coverage with RSpec
  • Continuous Integration with travis-CI and Heroku

Dependencies

  • Ruby 2.5.0
  • Rails 5.1.4
  • Node.js 6.0.0+
  • Yarn 0.25.2+
  • foreman

Getting started

Bundler is used to manage Ruby gems and Yarn is used to manage javascript packages.

Install ruby gem by running

bundle install

Install javascript packages by running

yarn

Database

Setup the base and run migrations by running

rails db:create
rails db:migrate

Configuration

Text Editor Configuration

This project utilizes .editorconfig to normalize development environments.

Environmental Variables

Development

Launching development server

To launch webpack-dev-server and rails server together, run the command below

foreman start -f PROCFILE.dev

Testing

Documentation on testing will be added in the future.

Deployment

Documentation on deployment to Heroku will be added in the future.