{"id":13877909,"url":"https://github.com/yatish27/shore","last_synced_at":"2025-04-08T03:19:24.758Z","repository":{"id":234379888,"uuid":"788778453","full_name":"yatish27/shore","owner":"yatish27","description":"Modern Ruby on Rails template to start every new project. Skip the boilerplate and focus on what's unique to your project.","archived":false,"fork":false,"pushed_at":"2025-03-27T03:55:28.000Z","size":1862,"stargazers_count":81,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-27T04:27:29.343Z","etag":null,"topics":["hotwire-turbo","ruby","ruby-on-rails","solid-queue","stimulusjs","tailwindcss","template","vite-rails"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yatish27.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-19T04:11:58.000Z","updated_at":"2025-03-27T03:55:31.000Z","dependencies_parsed_at":"2024-05-14T07:24:57.077Z","dependency_job_id":"88c014b2-fa3b-49e1-b2cd-741ec0f8d958","html_url":"https://github.com/yatish27/shore","commit_stats":null,"previous_names":["yatish27/shore"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yatish27%2Fshore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yatish27%2Fshore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yatish27%2Fshore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yatish27%2Fshore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yatish27","download_url":"https://codeload.github.com/yatish27/shore/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247767239,"owners_count":20992548,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hotwire-turbo","ruby","ruby-on-rails","solid-queue","stimulusjs","tailwindcss","template","vite-rails"],"created_at":"2024-08-06T08:01:34.642Z","updated_at":"2025-04-08T03:19:24.746Z","avatar_url":"https://github.com/yatish27.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"\u003ch1 align=\"left\"\u003e\n  \u003ca href=\"#\"\u003e\n    \u003cimg src=\"https://github.com/yatish27/shore/assets/1014383/fbad8ed2-9510-4693-a342-4bafa515b164\" width=\"128px\"/\u003e\n  \u003c/a\u003e\n\nShore\n\n  \u003cp align=\"left\"\u003e\n    \u003ca href=\"https://github.com/yatish27/shore/actions\"\u003e\n      \u003cimg alt=\"Build Status\" src=\"https://github.com/yatish27/shore/actions/workflows/ci.yml/badge.svg\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/yatish27/shore/blob/master/LICENSE.txt\"\u003e\n      \u003cimg alt=\"License\" src=\"https://img.shields.io/badge/license-MIT-428F7E.svg\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://codeclimate.com/github/yatish27/shore/maintainability\"\u003e\u003cimg src=\"https://api.codeclimate.com/v1/badges/1cd4e3f1c0a4c5af29b1/maintainability\" /\u003e\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/h1\u003e\n\n## Introduction\n\nShore is a Ruby on Rails template with modern stack to start your new project.\n\n## Features\n\n- **Ruby**: Ruby 3.4.2\n- **Rails**: [Rails 8](https://rubyonrails.org)\n- **PostgreSQL**: [PostgresSQL 17](https://www.postgresql.org)\n- **Tailwind CSS**: Uses [Tailwind CSS v4](https://tailwindcss.com) for styling.\n- **Vite Ruby**: Uses [Vite Ruby](https://vite-ruby.netlify.app) for asset management. It is based on [Vite.js](https://vitejs.dev). It replaces webpacker, jsbundling-rails, cssbundling-rails, importmaps and sprockets/propshaft.\n- **Node/Yarn**: Uses Node and Yarn for package management.\n- **Solid Queue**: Uses [Solid Queue](https://github.com/rails/solid_queue) for background processing.\n- **Rspec/FactoryBot**: Uses [RSpec](https://rspec.info/) and [Factorybot](https://github.com/thoughtbot/factory_bot).\n- **Rubocop**: Auto-formats Ruby code with [rubocop](https://rubocop.org).\n- **Prettier**: Auto-formats JavaScript and CSS code with [prettier](https://prettier.io).\n- **Github Actions**: Uses Github Actions for continuous integration and deployment.\n- **Deployment**: Supports deployment on [Heroku](https://www.heroku.com/platform) and [Render](https://render.com)\n\n## Getting Started\n\n### System Requirements\n\nYou will need the following to run the application.\n\n- [**Ruby 3.4.2**](./docs/installing_prerequisites.md#ruby)\n- [**PostgreSQL 17**](./docs/installing_prerequisites.md#postgresql)\n\nRefer [here](./docs/installing_prerequisites.md) to install these dependencies\n\n### Initial setup\n\n- Shore is a preconfigured base Ruby on Rails application. You can clone this repository and add it to your repo.\n\n  ```bash\n  git clone git@github.com:yatish27/shore.git your_new_project_name\n  cd your_new_project_name\n  ```\n\n- The application's default name is Shore. You can rename it to your desired new name. The name should be in camelcase.\n\n  ```bash\n  ./bin/rename_project YourNewProjectName\n  ```\n\n- Copy the `env.sample` to `.env`\n\n  - The default username and password for database is set to `postgres` and `postgres`. You can override them in `.env` file.\n\n- Run `bin/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.\n\n  ```bash\n  ./bin/setup\n  ```\n\n### Running the application\n\nStart your application\n\n```bash\n./bin/dev\n```\n\nThis runs overmind or foreman using the Procfile.dev. It starts the rails server, solid queue background job process and vite server.\n\nVisit [http://localhost:3000](http://localhost:3000) to see the home page 🚀.\n\n## Deployment\n\n- Heroku\n- Render\n\n## Testing\n\nRunning all tests\n\n```\n./bin/rspec\n```\n\nRunning a single spec\n\n```\n./bin/rspec spec/system/root_spec.rb\n```\n\n## License\n\nShore is released under the [MIT License](./LICENSE.txt).\n\n## Contributing\n\nPRs are welcome\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyatish27%2Fshore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyatish27%2Fshore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyatish27%2Fshore/lists"}