Wheel

Overview:

BigBinary is a software consultancy company that has developed a base project for quickly setting up a Rails application. This project follows the opinions and style of BigBinary. The project provides a local development setup as well as the option to use Docker for development. It also includes several features and uses various tools and gems for improved development and testing processes.

Features:

• Tailwind CSS: The project uses Tailwind CSS for styling the application.
• Devise: Devise gem is used for user authentication and authorization.
• Honeybadger: Honeybadger is used for error tracking and monitoring.
• Slim: Slim is used as the templating language for cleaner syntax and better performance.
• ActiveAdmin: ActiveAdmin gem is used for generating an admin dashboard.
• Sidekiq: Sidekiq is used as a background processing framework.
• Mail Interceptor: Outgoing emails in non-production environments are intercepted using the gem mail_interceptor.
• SemaphoreCI: SemaphoreCI is used for continuous testing.
• PostgreSQL: PostgreSQL is used as the database for the application.
• Rack::Deflater: Content compression is enabled using Rack::Deflater.
• Rubocop: Ruby code is automatically formatted using Rubocop.
• Prettier: JavaScript and CSS code are automatically formatted using Prettier.
• Letter Opener: Letter Opener gem is used for email preview in development.

Installation:

To install this base project, follow the steps below:

1. Clone this repository.
2. Install Node.js version v18.12 by running the following command:

   node install
   

   This command will install the specified Node.js version mentioned in the .node-version file.
3. Ensure that yarn is installed on your system as well.
4. Once yarn is installed, install the Node.js and Rails dependencies and seed the database by running:

   yarn install
   rails db:setup
   

5. Start the server by executing the following command:

   rails server
   

6. Open your web browser and visit http://localhost:3000. You can log in using the email oliver@example.com and password welcome.

Alternatively, if the above steps don’t work for some reason, you can choose to use Docker for development. Instructions for using Docker are mentioned [here](not provided).

Summary:

BigBinary’s base project provides developers with a quick way to set up a Rails application using their preferred opinions and style. It includes features such as Tailwind CSS, Devise for authentication, ActiveAdmin for generating an admin dashboard, Sidekiq for background processing, and more. The project also provides options for local development setup or using Docker. Overall, it offers a solid foundation for building web applications with Ruby on Rails.