You’re not punk, and I’m telling everyone.
Table of Contents
First make sure you have the following installed:
- Ruby 2.4.x
- PostgreSQL 9.6.x
- Node 6.10.x
- Yarn (or NPM)
After cloning the application and changing to its directory, you’ll want to run the setup script:
% bin/setup AppName app_name
- Install application dependencies
- Create your database
- Inject your app name into files where appropriate
That’s all there is to it. Spin up a server on http://localhost:3000 and start hacking:
% bin/rails server
Boxcar is an opinionated collection of content management and software development tools all bundled together and ready for you to start building client sites on top of.
It’s powered by a some awesome open source projects:
- Ruby on Rails, a web application framework that you may have heard of.
- Devise, a flexible authentication solution for Rails.
- Trestle, a customizable admin framework that makes Rails content management a snap.
- Webpacker, a project that integrates the webpack build tool into your Rails project.
There are a handful of useful Ruby libraries included; check the Gemfile to see what’s what.
Boxcar also comes loaded with some frontend libraries set up and ready for action:
Finally, some tools are configured and in place to help check your work:
bin/heroku_setup your-app-name; this script will set you up with
two Heroku apps (one for staging and one for production) with Heroku
PostgreSQL instances attached and in a development pipeline.
From then on, you can
bin/deploy to deploy to staging and
promote the staging app to production.
PRs accepted, however this is an admittedly opinionated framework based on what I use at work to get projects built quickly and with a high level of confidence. If you’re looking to make big changes to workflow or tooling you should fork the project.
If you do submit a PR, please adhere to the code of conduct.
Boxcar is released under the MIT License. Go wild.