andrewmcodesandrewmcodes
25

Shotgun

screenshot of Shotgun
rails
tailwind

Ready to go Rails App with TailwindCSS, ViewComponent, Devise, and more!

Github

Overview:

Shotgun is a Ruby on Rails application that is designed to help developers be more productive. The name "Shotgun" comes from the concept of shotgunning a beer, which is the act of consuming a beer at a high rate of speed. The goal of Shotgun is to provide a fast and efficient development environment.

Features:

  • Base Branch: The application uses "main" as the base branch for version control.
  • All Contributors: The project follows the all-contributors specification, allowing contributions from anyone.
  • GitHub License: The project is licensed under the MIT license and can be found on GitHub.
  • GitHub Issues: Users can report issues or bugs on the project's GitHub repository.
  • Contributions Welcome: The project welcomes contributions from developers.
  • WIP: Rails Shotgun: The project is a work in progress and is currently being developed.
  • System Dependencies: Requires Ruby version 2.7.1, Rails version 6.0.3.2, and PostgreSQL as the database.
  • Application Renaming: Users are advised to rename the application before proceeding with setup.
  • Configuration: Steps are provided for configuring the application, including setting up environment variables.
  • Automated and Manual Setup: Users can choose between automated or manual setup methods.
  • Database Creation: Instructions are provided for creating the database with necessary seed data.
  • Starting the App: Users can start the Ruby on Rails server and optionally run Sidekiq for background jobs.
  • Code Quality Checks: The application includes code quality analysis tools such as Brakeman, Fasterer, Rails Best Practices, and Bundler Audit.
  • Removed Gems: A list of gems that have been removed from the application.
  • Changelog: Coming soon.
  • Contributing: Guidelines and a code of conduct are provided for contributing to the project.
  • License: The project is licensed under the MIT license.
  • Contributors: A list of contributors is acknowledged and thanked.

Summary:

Shotgun is a Ruby on Rails application that aims to improve developer productivity. It provides a fast and efficient development environment with features such as configurable setup, code quality checks, and the ability to run background jobs. The project welcomes contributions and is licensed under the MIT license.

rails
Ruby on Rails

Ruby on Rails, often referred to as Rails, is an open-source web application framework written in Ruby. Known for its convention over configuration and don't repeat yourself (DRY) principles, Rails simplifies and accelerates the development of database-backed web applications.

tailwind
Tailwind

Tailwind CSS is a utility-first CSS framework that provides pre-defined classes for building responsive and customizable user interfaces.

template
Templates & Themes

A template or theme refers to a pre-designed layout or structure that provides a basic framework for building a specific type of application or website. It typically includes good design, placeholder content and functional features, allowing developers to customize and fill in the details according to their specific needs.