Repository files navigation

Shore is a Ruby on Rails template with modern stack to start your new project.

• Ruby: Ruby 3.4.4
• Rails:Rails 8
• PostgreSQL:PostgresSQL 17
• Tailwind CSS: UsesTailwind CSS v4 for styling.
• Vite Ruby: UsesVite Ruby for asset management. It is based onVite.js. It replaces webpacker, jsbundling-rails, cssbundling-rails, importmaps and sprockets/propshaft.
• Node/NPM: Uses Node and npm for package management.
• Solid Queue: UsesSolid Queue for background processing.
• Rspec/FactoryBot: UsesRSpec andFactorybot.
• Rubocop: Auto-formats Ruby code withrubocop.
• Prettier: Auto-formats JavaScript and CSS code withprettier.
• Github Actions: Uses Github Actions for continuous integration and deployment.
• Deployment: Supports deployment onHeroku andRender

You will need the following to run the application.

• Ruby 3.4.4
• PostgreSQL 17

Referhere to install these dependencies

• Shore is a preconfigured base Ruby on Rails application. You can clone this repository and add it to your repo.

  git clone git@github.com:yatish27/shore.git your_new_project_namecd your_new_project_name

• The application's default name is Shore. You can rename it to your desired new name. The name should be in camelcase.

  ./bin/rename_project YourNewProjectName

• Copy theenv.sample to.env

  • The default username and password for database is set topostgres andpostgres. You can override them in.env file.

• Runbin/setup to set up the application. It prepares the database and installs the required ruby gems and javascript packages. The script is idempotent, so you can run it multiple times.

  ./bin/setup

Start your application

./bin/dev

This runs overmind or foreman using the Procfile.dev. It starts the rails server, solid queue background job process and vite server.

Visithttp://localhost:3000 to see the home page 🚀.

• Heroku
• Render

Running all tests

./bin/rspec

Running a single spec

./bin/rspec spec/system/root_spec.rb

Shore is released under theMIT License.

PRs are welcome