https://github.com/euxx/rails_skeleton

Rails 6/7 skeleton
https://github.com/euxx/rails_skeleton

rails-skeleton rails-template rails7 rails8 skeleton template

Last synced: 28 days ago
JSON representation

Rails 6/7 skeleton

• Host: GitHub
• URL: https://github.com/euxx/rails_skeleton
• Owner: euxx
• License: mit
• Created: 2019-05-05T15:11:09.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-11-13T10:20:53.000Z (about 2 months ago)
• Last Synced: 2024-11-20T14:50:09.332Z (about 1 month ago)
• Topics: rails-skeleton, rails-template, rails7, rails8, skeleton, template
• Language: Ruby
• Homepage:
• Size: 876 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Rails skeleton

[![Github Actions](https://github.com/euxx/rails_skeleton/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/euxx/rails_skeleton/actions/workflows/ci.yml)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/eff349d9f6a742d7bfa1f7fb8a4a3a4f)](https://www.codacy.com/manual/eux/rails_skeleton/dashboard)

Rails skeleton with Ruby 3 and Rails 8

In favor of

- [PostgreSQL](https://github.com/ged/ruby-pg)

- [esbuild](https://github.com/evanw/esbuild)

- [Turbo](https://github.com/hotwired/stimulus-rails)

- [Stimulus](https://github.com/hotwired/turbo-rails)

- [Rails Credentials](https://edgeguides.rubyonrails.org/security.html#custom-credentials)

- [Active Storage](https://edgeguides.rubyonrails.org/active_storage_overview.html)

- [Bootstrap](https://github.com/twbs/bootstrap)

- [FontAwesome](https://github.com/FortAwesome/font-awesome-sass)

- [Rails Authentication Generator](https://www.bigbinary.com/blog/rails-8-introduces-a-basic-authentication-generator)

- [Solid Cache](https://github.com/rails/solid_cache)

- [Solid Queue](https://github.com/rails/solid_queue)

In favor of services

- [Github Actions](https://github.com/features/actions) for CI

- [Codacy](https://www.codacy.com) for code quality

- [Skylight](https://www.skylight.io) for performance monitoring

- [Sentry](https://sentry.io) for error tracking

## Getting Started

```sh

$ bin/setup app_name=your_app_name

$ rails test:all

$ rails s

```

## Edit Things

- Rename the repository to your_app_name

- Setup credentials by following

  [config/credentials.guide.md](https://github.com/euxx/rails_skeleton/blob/master/config/credentials.guide.md)

- Add necessary API keys by following

  [config/credentials.yml.sample](https://github.com/euxx/rails_skeleton/blob/master/config/credentials.yml.sample)

- Set `TAG_ENV` environment variable to specific server environment like 'production' (default is 'staging') for Sentry and Skylight

- Edit `title`, `keywords` and `description` at HTML Head in

  `app/views/layouts/application.html.erb`

- Replace `app/assets/images/favicon.png` with yours

- Custom errors page in `app/views/errors/`

- Update README

## Tips

- There's a helper `icon(style, name, text = nil, html_options = {})`

  to generate Font Awesome icons