Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yatish27 committed May 7, 2024
1 parent 23d356a commit 4603488
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,37 @@
![shore_logo_128](https://github.com/yatish27/shore/assets/1014383/fbad8ed2-9510-4693-a342-4bafa515b164)

# Shore

This is a Rails 7.1 app.
A cutting-edge and opinionated Ruby on Rails template equipped with pragmatic defaults to kickstart your next project 🚀



![example workflow](https://github.com/yatish27/shore/actions/workflows/ci.yml/badge.svg)

This template serves as a robust foundation, providing all the necessary setups and defaults required for launching a new Ruby on Rails application swiftly.


## Features 🌟
- **Ruby & Rails**: Ruby 3.3.1 with Rails 7.1.2
- **Styling**: TailwindCSS
- **Asset managment**: [ViteRuby](https://github.com/ElMassimo/vite_ruby)
- **Front-end Libraries**: Hotwire, Turbo & StimulusJS
- **Views**: [Phlex](https://www.phlex.fun)
- **Package Management**: [Bun](https://bun.sh). It replaces Node and Yarn.
- **Testing Suite**:
- Minitest for unit and functional integration tests
- FactoryBot for setting up test data
- cypress-rails for end-to-end system tests
- **Background Processing**: SolidQueue
- **Linting and formatting**: Rubocop
- **Containerization**:
- Docker support with separate Dockerfiles and docker-compose.yml for development, test, and production environments
- **Continuous Integration**: Automated workflows with GitHub Actions
- **Deployment Options**:
- Heroku
- Render
- Hatchbox.io
- DigitalOcean with Kamal

## Prerequisites

Expand Down

0 comments on commit 4603488

Please sign in to comment.