schienenzeppelin 0.1

data/GALLERY.md

@@ -0,0 +1,29 @@
+# Gallery
+
+Schienenzeppelin comes with a nice and unobstrusive UI to get you started quickly.
+
+## Home
+
+TailwindCSS and responsive views already done. Minimalism first, so these things stay out of your way.
+
+![home](./images/home.png)
+![home_mobile](./images/mobile.png)
+
+## Devise
+
+All devise forms (login, sign up, profile...) feature the same simple design.
+
+![devise](./images/login.png)
+
+## Scaffold
+
+Adding new views via `rails scaffold` tends to result in a ton of work to get those to look nice. Not anymore!
+
+![scaffold](images/index.png)
+![create](images/create.png)
+
+## Error Pages
+
+Even if things go wrong, they should look nice, right?
+
+![error](images/error.png)

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in schienenzeppelin.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.10'
+
+gem 'rubocop', '~> 1.9'
+gem 'rubocop-rspec', '~> 1.40'

data/Gemfile.lock

@@ -0,0 +1,184 @@
+PATH
+  remote: .
+  specs:
+    schienenzeppelin (0.1)
+      rails (~> 6.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.2.1)
+      actionpack (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.2.1)
+      actionpack (= 6.1.2.1)
+      activejob (= 6.1.2.1)
+      activerecord (= 6.1.2.1)
+      activestorage (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.2.1)
+      actionpack (= 6.1.2.1)
+      actionview (= 6.1.2.1)
+      activejob (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.2.1)
+      actionview (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.2.1)
+      actionpack (= 6.1.2.1)
+      activerecord (= 6.1.2.1)
+      activestorage (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.2.1)
+      activesupport (= 6.1.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.2.1)
+      activesupport (= 6.1.2.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.2.1)
+      activesupport (= 6.1.2.1)
+    activerecord (6.1.2.1)
+      activemodel (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+    activestorage (6.1.2.1)
+      actionpack (= 6.1.2.1)
+      activejob (= 6.1.2.1)
+      activerecord (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      marcel (~> 0.3.1)
+      mimemagic (~> 0.3.2)
+    activesupport (6.1.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    minitest (5.14.3)
+    nio4r (2.5.5)
+    nokogiri (1.11.1-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.2.1)
+      actioncable (= 6.1.2.1)
+      actionmailbox (= 6.1.2.1)
+      actionmailer (= 6.1.2.1)
+      actionpack (= 6.1.2.1)
+      actiontext (= 6.1.2.1)
+      actionview (= 6.1.2.1)
+      activejob (= 6.1.2.1)
+      activemodel (= 6.1.2.1)
+      activerecord (= 6.1.2.1)
+      activestorage (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.2.1)
+      actionpack (= 6.1.2.1)
+      activesupport (= 6.1.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.9.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-rspec (1.42.0)
+      rubocop (>= 0.87.0)
+    ruby-progressbar (1.11.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  rubocop (~> 1.9)
+  rubocop-rspec (~> 1.40)
+  schienenzeppelin!
+
+BUNDLED WITH
+   2.2.7

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Hans-Jörg Schnedlitz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 hschne
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,174 @@
+<h1 align="center">Schienenzeppelin</h1>
+
+<p align="center">
+<img src="https://github.com/hschne/schienenzeppelin/workflows/Ruby/badge.svg"/>
+<img src="https://badge.fury.io/rb/pundit.svg"/>
+</p>
+
+The Ruby on Rails app generator to get you started quickly. Includes TailwindCSS,
+Devise, Capistrano and much more. Check out these [screenshots](GALLERY.md) and [What's in the Box](#whats-in-the-box) to find out more.
+
+![zeppelin](./schienenzeppelin.jpg)
+
+## Getting Started
+
+Install the Schienenzeppelin gem:
+
+```
+gem install schienenzeppelin
+```
+
+Make sure you have [Ruby](https://www.ruby-lang.org/en/) and [ Yarn ](https://yarnpkg.com/) installed. Then run:
+
+```
+sz <app-name>
+```
+
+## What's in the Box?
+
+Loads of things!
+
+Schienenzeppelin provides you with a ready-to-go Rails app that you can take to production in a matter of minutes. It comes pre-configured with several gems and utilities that - while kind of standard - are not included in the default Rails app generator. Some highlights include:
+
+- Fully responsive pages using [TailwindCSS](https://tailwindcss.com/) and [High Voltage](https://github.com/thoughtbot/high_voltage) out of the box. And custom scaffolds to boot! :sparkles:
+- Authentication & Authorization comes standard. Starting your app with Schienenzeppelin means [Devise](https://github.com/heartcombo/devise) is already set up :+1:
+- Dockerized everything. That includes a Dockerfile to get you started with containerizing your app, and a [docker-compose](https://docs.docker.com/compose/)-powered development environment :whale:
+- Deploying your app is easy as pie. All the basic [Capistrano](https://capistranorb.com/) configuration is done already, just put in your server location and you are off to the races :rocket:
+
+### Frontend
+
+The nice thing about Schienenzeppelin is that it sets you up with basic pages that don't look like garbage - allowing you to focus on other things than design.
+
+Curious what that looks like? Check out these [screenshots](GALLERY.md).
+
+#### Tailwind CSS
+
+Schienenzeppelin comes pre-configured with [tailwindcss-rails](https://github.com/rails/tailwindcss-rails). We provide several UI components as a starting point in `app/javascript/stylesheets/components.scss` - easy to adapt, and easy to add your own.
+
+#### Custom Views
+
+[High Voltage](https://github.com/thoughtbot/high_voltage) offers an easy way to add static pages - no controllers needed. Out of the box, Schienenzeppelin provides a mobile-friendly home page and an improved application layout.
+
+#### Custom Scaffold
+
+Schienenzeppelin adds a bunch of scaffolds that you adapt to suit your own needs in `lib/scaffolds`. These scaffolds take advantage of Tailwind to match the look of the rest of your application.
+
+#### Turbo
+
+[Hotwire](https://hotwire.dev/) is the new hotness. Starting with Schienenzeppelin means that Hotwire and its components such as [Stimulus](https://github.com/hotwired/stimulus) are already added to your application.
+
+Schienenzeppelin also takes advantage of [Tailwind-Stimulus-Components](https://github.com/excid3/tailwindcss-stimulus-components) to provide interactive componenets (Dropdowns, Alerts...) out of the box.
+
+### Backend
+
+Modern web apps need tons of functionality out of the box. Authentication, Authorization, APIs and much more. Schienenzeppelin comes with some basics to get you started quickly.
+
+#### Authentication
+
+Devise is already configured if you start your application with Schienenzeppelin. For a smooth first start, `db/seeds.rb` create an admin user, and your navigation bar already contains links where users can sign in or sign up.
+
+#### Authorization
+
+[Pundit](https://github.com/varvet/pundit) provides a simple way to encapsulate authorization logic in your application. You can add new policies to the `app/policies` folder. To generate a new policy run `rails generate pundit:policy`.
+
+#### Background Jobs
+
+Schienenzeppelin per default foregoes ActiveJob in favor of [Sidekiq](https://github.com/mperham/sidekiq).
+
+#### OJ
+
+To serialize and deserialize to and from Json [OJ](https://github.com/ohler55/oj) is pretty much standard. Schienenzeppelin already comes pre-configured with it.
+
+#### JB
+
+For rendering JSON views we use [JB](https://github.com/amatsuda/jb) instead of [JBuilder](https://github.com/rails/jbuilder), as it is both faster and simpler to use.
+
+#### Service Objects
+
+[Service Objects](https://www.toptal.com/ruby-on-rails/rails-service-objects-tutorial) are a simple, straight-forward way to encapsulate your business logic and keep your controllers and models nice and slim.
+
+Schienenzeppelin provides a basic service object base class you can inherit from to add your own service objects in `app/services`.
+
+### Development
+
+#### Setup Script
+
+A setup script that allows for easy setup of the application on a new machine is provided. It is automatically tailored to your specific
+app configuration.
+
+#### Start Script
+
+Once you have set up everything your application can be started with a single command-line call - using Foreman. All necessary procfiles are generated.
+
+#### Better Rails Console
+
+Schienenzeppelin comes with a custom `.irbrc` that adds history and syntax completion. [Factory Bot](#factory_bot) methods will also be available in the console.
+
+#### Annotate
+
+[Annotate](https://github.com/ctran/annotate_models) adds comments to your models to show the current table schema. Automatically run during each migration.
+
+#### Database
+
+PostgreSQL is already configured if you start your app - in such a way that it plays nicely with other utilities such as `dotenv` and `docker-compose` too!
+
+#### Dotenv
+
+[Dotenv](https://github.com/bkeepers/dotenv) is a nifty gem that makes environment variables easier to manage.
+
+#### Docker
+
+Docker is incredibly helpful when developing and deploying your application. Schienenzeppelin provides a `docker-compose` file
+as well as an optimized `Dockerfile` (with complementary `.dockerignore`) to get you started.
+
+#### Version Manager Support
+
+We added support for the [asdf version manager](https://asdf-vm.com/#/). A `.tool-versions` file is automatically included in your app.
+
+#### Improved Gitignore
+
+Schienenzeppelin provides a custom `.gitignore` that is tailored to your app.
+
+#### Rubocop
+
+Creating your app with Schienenzeppelin will automatically add Rubocop and a minimal set of Rubocop rules for both your production and test code.
+
+#### Improved Credentials
+
+While Rails secrets are usually prepared for development, Schienezeppelin sets up everything for production as well.
+
+#### Rspec
+
+[Rspec](https://github.com/rspec/rspec) and its helpers [rspec-mocks](https://github.com/rspec/rspec-mocks) and [shoulda](https://github.com/thoughtbot/shoulda) come standard.
+
+#### Factorybot
+
+[Factorybot](https://github.com/thoughtbot/factory_bot) provides an easy way to create test data.
+
+### Deployment & CI
+
+#### Github Actions
+
+Schienenzeppelin already comes with a workflow file that should cover your basic need. A good starting point for further customization.
+
+#### Capistrano
+
+Capistrano is already set up. Deploy to a server of your choice with minimal effort.
+
+## FAQ
+
+#### Why another template generator?
+
+I wanted something that fits the way I like to write my Rails app. There are many application templates, but this one is mine.
+
+#### What's with the German gibberish name?
+
+I'm so glad you asked. The [Schienenzeppelin](https://en.wikipedia.org/wiki/Schienenzeppelin) was an experimental railcar that was briefly in operation during the 1930s. It was pretty fast, and it ran on Rails. Get it? :zany_face:
+
+#### Credits
+
+This idea is nothing new, and there are tons of other projects I took inspiration from.
+
+Special shout out to Chris Oliver, whose [Jumpstart Pro](https://jumpstartrails.com/) is crazy good. You should get it.
+
+[Suspenders](https://github.com/thoughtbot/suspenders) was where I first came across the idea to try my hand at custom template generators.