https://github.com/subins2000/wheel
Don't reinvent the wheel for every new Rails project. Use sane Defaults.
https://github.com/subins2000/wheel
Last synced: 5 months ago
JSON representation
Don't reinvent the wheel for every new Rails project. Use sane Defaults.
- Host: GitHub
- URL: https://github.com/subins2000/wheel
- Owner: subins2000
- Created: 2021-09-02T14:32:57.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-02T14:35:06.000Z (almost 5 years ago)
- Last Synced: 2025-06-05T13:47:45.325Z (about 1 year ago)
- Homepage: https://wheel-production.herokuapp.com/
- Size: 2.24 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://bigbinary.semaphoreci.com/projects/wheel)
Made by the team at [BigBinary](https://bigbinary.com), this is a base project to quickly spin up a
Rails application built with opinions of BigBinary style of working.
## Local Development Setup
Clone this repo by running `git clone https://github.com/bigbinary/wheel.git`.
Install the [Node.js](https://nodejs.org) version `v16.5` which we have specified inside the `.node-version` file.
```bash
nvm install
```
Make sure that [yarn](https://yarnpkg.com) is installed with it as well.
```bash
./bin/setup
```
Start the server by executing following command.
```bash
bundle exec rails server
```
Visit http://localhost:3000 and login with email `oliver@example.com` and password `welcome`.
## Using docker for development
Follow the instructions mentioned [here](https://github.com/bigbinary/wheel/blob/master/docs/using_docker.md) to use docker for development.
## Replace Wheel with your project name
Let's say that the project name is `Pump`. Execute the command below to
replace all occurrences of `Wheel` with `Pump`.
```bash
perl -pi -w -e 's/Wheel/Pump/g;' $(git ls-files)
perl -pi -w -e 's/wheel/Pump/g;' $(git ls-files)
```
## Features
- Uses [Tailwind CSS](https://tailwindcss.com).
- `rake setup` to set sensible sample data including user `oliver@example.com` with password `welcome`.
- Uses [devise](https://github.com/plataformatec/devise).
- Heroku ready. Push to Heroku and it will work.
- Uses [Honeybadger](https://www.honeybadger.io/).
- Uses slim for cleaner syntax over erb and better performance over haml.
- Uses [ActiveAdmin](http://activeadmin.info).
- Uses [Sidekiq](https://github.com/mperham/sidekiq).
- Intercepts all outgoing emails in non production environment using gem [mail_interceptor](https://github.com/bigbinary/mail_interceptor).
- Uses [SemaphoreCI](https://semaphoreci.com/) for continuous testing.
- Uses PostgreSQL.
- Content compression via [Rack::Deflater](https://github.com/rack/rack/blob/master/lib/rack/deflater.rb).
- Auto-formats Ruby code with [rubocop](https://github.com/bbatsov/rubocop).
- Auto-formats JavaScript and CSS code with [prettier](https://github.com/prettier/prettier).
- Performs background job processing "inline" for heroku env. It means heroku can deliver emails.
- Letter opener gem for development.
## Heroku Review
[Heroku Review](https://devcenter.heroku.com/articles/github-integration-review-apps)
is enabled on this application. It means when a PR is sent then Heroku
automatically deploys an application for that branch.
## About BigBinary
wheel is maintained by [BigBinary](https://www.BigBinary.com). BigBinary is a software consultancy company. We build web and mobile applications using Ruby on Rails, React.js, React Native and Node.js.