Browse Source

improve README for root and lite

trunk
Thomas Riboulet 7 months ago
parent
commit
defabfd0ac
  1. 29
      README.md
  2. 16
      lite/README.md

29
README.md

@ -0,0 +1,29 @@
# Rails templates
This repository regroups template to get RubyOnRails app started.
## lite
A basic template to get started with just enough :
- postgresql
- rspec
- haml
- postmarkapp
- byebug
- bulma for the css basis
It has a very simple landing page and that's it.
## basic
A bigger basis to start with. In addition to the above :
- clearance (authentication)
- pundit (authorization)
This template get you started with a few features already in :
- a landing page
- a sign up form and page
- a sign in form and page
- admin and regular roles for users
- admin dashboard to list and manage users
- a simple dashboard for regular users to change their information, password

16
lite/README.md

@ -2,9 +2,10 @@
## Description
This is the application template that I recommend for Rails 7 projects. I've assembled this template over the years to include best-practices, tweaks, documentation, and personal preferences, while still generally adhering to the "Rails way".
### This is a fork
This is based on the excellent work from https://github.com/mattbrictson/rails-template and aimed at working with Rails 7 projects.
For older versions of Rails, use these branches:
For older versions of Rails, please refer to the original repository and use these branches:
* [Rails 6.1.x](https://github.com/mattbrictson/rails-template/tree/rails-61)
* [Rails 6.0.x](https://github.com/mattbrictson/rails-template/tree/rails-60)
@ -13,6 +14,12 @@ For older versions of Rails, use these branches:
* [Rails 5.0.x](https://github.com/mattbrictson/rails-template/tree/rails-50)
* [Rails 4.2.x](https://github.com/mattbrictson/rails-template/tree/rails-42)
These will give you a good head start albeit with some different choices for some parts.
### What it is
This is the application template that I recommend for Rails 7 projects. I've assembled this template over the years to include best-practices, tweaks, documentation, and personal preferences, while still generally adhering to the "Rails way".
## Requirements
This template currently works with:
@ -86,15 +93,16 @@ If you don't specify `--javascript vite`, then this template will use the standa
* Configuration
* [dotenv][] – for local configuration
* Style
* [Pico.css][pico] - a great-looking default stylesheet
* [Bulma][] - a nice, simple yet powerful css framework
* Utilities
* [annotate][] – auto-generates schema documentation
* [amazing_print][] – try `ap` instead of `puts`
* [rubocop][] – enforces Ruby code style
* [flay][] - dig deeper into code style and code structure
* Security
* [brakeman][] and [bundler-audit][] – detect security vulnerabilities
* Testing
* [rspec][] – shortcuts for common ActiveRecord tests
* [rspec][] – A good basis for tests.
#### Postmark

Loading…
Cancel
Save