{"id":15511016,"url":"https://github.com/andrewmcodes/shotgun","last_synced_at":"2025-04-28T11:48:05.393Z","repository":{"id":39089537,"uuid":"272106803","full_name":"andrewmcodes/shotgun","owner":"andrewmcodes","description":"Ready to go Rails App with TailwindCSS, ViewComponent, Devise, and more!","archived":false,"fork":false,"pushed_at":"2023-01-19T19:26:11.000Z","size":1474,"stargazers_count":25,"open_issues_count":33,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-09T16:12:23.076Z","etag":null,"topics":["devise","rails","sidekiq","stimulus","stimulusjs","tailwindcss","template","webpacker"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andrewmcodes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null}},"created_at":"2020-06-14T00:23:45.000Z","updated_at":"2024-10-29T01:13:21.000Z","dependencies_parsed_at":"2023-02-11T18:30:17.901Z","dependency_job_id":null,"html_url":"https://github.com/andrewmcodes/shotgun","commit_stats":null,"previous_names":[],"tags_count":2,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrewmcodes%2Fshotgun","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrewmcodes%2Fshotgun/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrewmcodes%2Fshotgun/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrewmcodes%2Fshotgun/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andrewmcodes","download_url":"https://codeload.github.com/andrewmcodes/shotgun/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234456347,"owners_count":18835764,"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":["devise","rails","sidekiq","stimulus","stimulusjs","tailwindcss","template","webpacker"],"created_at":"2024-10-02T09:52:26.281Z","updated_at":"2025-01-18T03:19:12.958Z","avatar_url":"https://github.com/andrewmcodes.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"![Base Branch](https://img.shields.io/badge/base%20branch-main-important)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n![GitHub License](https://img.shields.io/github/license/andrewmcodes/shotgun)\n![GitHub issues](https://img.shields.io/github/issues/andrewmcodes/shotgun)\n[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](CONTRIBUTING.md)\n\n# WIP: Rails Shotgun\n\nRuby on Rails application initialized with all the good stuff. Use at your own risk or we welcome pull requests. I will be working on a roadmap soon.\n\n## Why is it named Shotgun??\n\n\u003e Shotgunning a beer is the simple act of consuming a beer at a high rate of speed.\n\nThe inspiration came from one of my common college activities. Rails Shotgun lets you be as productive as shotgunning a beer is at getting you drunk.\n\n## Setup\n\nPlease take note that we are using `main` as the base branch.\n\n![Base Branch](https://img.shields.io/badge/base%20branch-main-important)\n\n### System dependencies\n\n- Ruby version: 2.7.1\n- Rails version: 6.0.3.2\n- Database: PostgreSQL\n- Redis installed\n\n### Rename Application\n\nYou will want to rename the application first. Here are some options:\n\n- Watch the [CodeTour](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.codetour)\n- Find and replace `CHANGEME` throughout. Note that if you take this method, you need to be aware of using the correct case.\n\n### Configuration\n\nMake sure the app has been renamed before doing these steps.\n\n#### Automated\n\n```bash\nbin/setup\n```\n\n#### Manually\n\n```\nCopy an existing sample environment file. Run:\n\n```bash\n$ cp .env.sample .env\n```\n\nand edit newly created `.env` file. The minimum you are going to need are\ncredentials to your local PostgreSQL database.\n\nThen, install all the necessary dependencies:\n\n```bash\nbundle install \u0026\u0026 yarn install\n```\n\n### Database creation\n\nIn order to create the database with all the necessary seed data, run:\n```bash\nrails db:create db:schema:load db:seed\n```\n\n### How to start the app\n\nStart the Ruby on Rails server with:\n```bash\nrails server\n```\n\nWe __highly__ recommend running the weback dev server in another tab instead of inline compilation that will occur if you don't for speed.\n\n```bash\nbin/webpack-dev-server\n```\n\nTo _optionally_ run Sidekiq, launch another process with:\n```bash\nbundle exec sidekiq\n```\n\n### Code quality checks\n\nThe application provides the following code quality analysis tools:\n\n- [Brakeman][brakeman]\n- [Fasterer][fasterer]\n- [Rails Best Practices][rails-best-practices]\n- [Bundler Audit][bundler-audit]\n\nTo run them locally:\n\n```bash\n$ bundle exec brakeman\n$ bundle exec fasterer\n$ bundle exec rails_best_practices\n$ bundle audit\n```\n\n[brakeman]: https://github.com/presidentbeef/brakeman\n[fasterer]: https://github.com/DamirSvrtan/fasterer\n[rails-best-practices]: https://github.com/flyerhzm/rails_best_practices\n[bundler-audit]: https://github.com/rubysec/bundler-audit\n\n### Removed Gems\n\n- [redis-namespace](https://github.com/resque/redis-namespace)\n  - Not needed and it was throwing a bunch of warnings.\n- [active-record-observer](https://github.com/rails/rails-observers#active-record-observer)\n  - Unused\n- [activeresource](https://github.com/rails/activeresource)\n  - Unused\n- [ngrok-tunnel](https://github.com/bogdanovich/ngrok-tunnel)\n  - Not needed if using tmuxinator\n- [better_errors](https://github.com/BetterErrors/better_errors)\n  - Not really needed anymore now that Rails has made some improvements that made this a real nice-to-have\n\n### Changelog\n\nComing Soon\n\u003c!-- [View our Changelog][changelog] --\u003e\n\n### Contributing\n\n[Contributing Guide][contributing]\n\n### Code of Conduct\n\n[Code of Conduct][coc]\n\n### License\n\n[MIT][license]\n\n\n[changelog]: /CHANGELOG.md\n[coc]: /CODE_OF_CONDUCT.md\n[contributing]: /CONTRIBUTING.md\n[license]: /LICENSE\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://www.andrewm.codes\"\u003e\u003cimg src=\"https://avatars1.githubusercontent.com/u/18423853?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eAndrew Mason\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/andrewmcodes/shotgun/commits?author=andrewmcodes\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#ideas-andrewmcodes\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"#infra-andrewmcodes\" title=\"Infrastructure (Hosting, Build-Tools, etc)\"\u003e🚇\u003c/a\u003e \u003ca href=\"#maintenance-andrewmcodes\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e \u003ca href=\"https://github.com/andrewmcodes/shotgun/pulls?q=is%3Apr+reviewed-by%3Aandrewmcodes\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e \u003ca href=\"#question-andrewmcodes\" title=\"Answering Questions\"\u003e💬\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/cjilbert504\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/54157657?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ecjilbert504\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/andrewmcodes/shotgun/commits?author=cjilbert504\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/andrewmcodes/shotgun/issues?q=author%3Acjilbert504\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrewmcodes%2Fshotgun","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrewmcodes%2Fshotgun","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrewmcodes%2Fshotgun/lists"}