Shotgun

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.

Installation:

1. Rename the application to your desired name.
2. Setup the necessary configuration by following these steps:
   • Automated Setup:
     1. Run the automated setup script provided.
   • Manual Setup:
     1. Manually edit the newly created .env file, ensuring you include the credentials for your local PostgreSQL database.
     2. Install all the necessary dependencies.
3. Database Creation:
   • To create the database with seed data, run the appropriate command.
4. Starting the App:
   • Start the Ruby on Rails server using the provided command.
   • Optionally, run Sidekiq for background jobs using the provided command.
5. Code Quality Checks:
   • To run the code quality analysis tools, follow the instructions provided.

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.