localtower 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9db89fe02b54c1eb46633f4df610405c050aaf5a44bcdc22a90ffe7cbb54637b
-  data.tar.gz: 6738a7be7646e0c4cf0844def2b6785f659922c064cf5e7e0ac39242c6f5f7b4
+  metadata.gz: fd3ff9f10242f64a0f36e8d73592bef75040acd230395290234a92334072098a
+  data.tar.gz: a105385c40e1e640751a1547c45fb6e06070992d061efbea8f4d570632cd14b9
 SHA512:
-  metadata.gz: 2388bae27139b79e346b70fab53701f87112aca41d104fa3dcd8b2b9d3537dc9d54742c990384135cc347b50207d5023d96b699847b568731e78ed1204a3afe5
-  data.tar.gz: 18959e622626a9452fdc67dae321ef93f1be65e81657e66ad692f330bfe2fc47c29fb731c66adddd3d61f718c286caf70b9b0fa9e219ec616aea5acfd8aaee71
+  metadata.gz: 46963d7e5e65127f9e374f1b2d3f7311b5d1bca07b75d4036db746232c8d14da1a25daef877ee58e74e157bd1b35960c76c7ee921721aebf80eadf3785666b9a
+  data.tar.gz: 3789b9562e8b06f2e040d404ea0a5f6e7a002ba08e1b42a19fd07c85dee65e07911c229120b57a0f9492f1ec6a6aa523dd98600a397f52760c2b0200185ce56d

data/README.md

@@ -1,46 +1,80 @@
+![Gem](https://img.shields.io/gem/v/localtower) ![Gem](https://img.shields.io/gem/dt/localtower?label=gem%20downloads)
+
 <p align="center">
-<img src="https://raw.githubusercontent.com/damln/localtower/master/public/logo-localtower-white-300.png" alt="Localtower">
+<img src="https://raw.githubusercontent.com/damln/localtower/0f279b82e9a7701b9f0aab21a8e4561468535046/public/com/twitter-cover-2.png" alt="Localtower">
 </p>
 
-## Intro
+## Introduction
 
-Please use localtower version `>= 1.0.0`
-See installation process below.
+![New Model](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.44.30.jpg)
 
-Compatibility:
-- Rails >= 5.2
-- Ruby >= 2.3
+**- What is Localtower?**
+
+Localtower is a Rails Engine mountable in development environment to help you generate migrations for your Rails application.
+It's like ActiveAdmin or Sidekiq UI.
+You plug it in your `config/routes.rb` and it works out of the box.
+Check the _Installation_ section below for more details.
+
+**- How Localtower works?**
+
+Localtower gives you a UI to create models and migrations. It will generate a migration file like you would do with `rails generate migration add_index_to_users`. You will see the generated file in `db/migrate/` folder.
+
+**- Why creating a UI for Rails migrations?**
+
+Rails migrations are well documented in the official [Rails Guides](https://guides.rubyonrails.org/active_record_migrations.html) but we often tend to forget some commands or do typo errors. Like writing `add_index :user, :email` instead of `add_index :users, :email` (did you spot the typo?). Working from a UI with a fixed list of commands reduces the chance of making errors.
+
+**- When I'm using Localtower, can I still generate migrations from the command line?**
+
+Of course! Localtower does not lock you up. You can still generate migrations like you did before. Localtower is just a migration generator. You can also generate a migration from Localtower and then edit it manually before running `rails db:migrate`
+
+**- What does happen when I want to remove Localtower?**
+
+You just have to remove the gem from your `Gemfile`, run `bundle`, remove the engine in `config/routes.rb`, and that's it! All your previous migrations will stay in `db/migrate/`. You are never locked up with Localtower. You can install or uninstall anytime. Remember, it is just a UI to generate files. Do not hesitate to [open an issue on Github](https://github.com/damln/localtower/issues) and tell me why you don't want it anymore. It will be very valuable for me to understand what I can do better ❤.
+
+**- Cool, but there are some migration options that are not available in Localtower, what can I do?**
+
+Localtower doesn't implement all the Rails Migrations API. I focused on the most common scenarios. If you need to do something tricky in your migrations, you can still edit the migrations manually. You are also welcome to [open an issue on Github](https://github.com/damln/localtower/issues) to ask for a specific feature. I'm always open to extend the possibilities of Localtower.
+
+## Screenshots
 
 ### Create a model
-![New Model](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v1.0.0/new_model.png)
+
+![New Model](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.44.30.jpg)
 
 ### Create a migration
-![New Migration](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v1.0.0/new_migration.png)
 
-### See the Models
-![Models](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v1.0.0/models.png)
+![New Migration](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.48.21.jpg)
 
 ### See the Migrations (and migrate)
-![Migrations](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v1.0.0/migrations.png)
 
-## INSTALL
+![Migrations](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.50.11.jpg)
 
-Should work with any Rails 5.2+ application.
-Only tested with PostgreSQL.
+## Installation
+
+Please use the best localtower version: `>= 2.0.0`
+See installation process below.
+
+Compatibility:
+
+- Rails >= 5.2
+- Ruby >= 2.3
 
 Add to your `Gemfile` file:
+
 ```ruby
 group :development do
-  gem "localtower"
+  gem 'localtower', '~> 2.0'
 end
 ```
 
 Run command in your terminal:
+
 ```bash
 bundle install
 ```
 
 Add to your `config/routes.rb`:
+
 ```ruby
 MyApp::Application.routes.draw do
   if Rails.env.development?
@@ -52,7 +86,8 @@ MyApp::Application.routes.draw do
 end
 ```
 
-/!\ IMPORTANT /!\
+**⚠ IMPORTANT ⚠**
+
 Change your config/environments/development.rb:
 
 ```ruby
@@ -71,13 +106,69 @@ If you know how to override this configuration in the gem instead of doing it in
 
 ## Usage
 
-Open your browser at [http://localhost:3000/localtower](http://localhost:3000/localtower).
+To access the UI, run your local rails server and open your browser at [http://localhost:3000/localtower](http://localhost:3000/localtower).
+
+## Full scenario
+
+### Create a model
 
-## Roadmap
+![](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.44.30.jpg)
+
+It will create a migration file:
+
+![](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.44.42.jpg)
+
+### Create a migration
 
-- Be able to use `uuid` instead of `id` as primary when creating models.
-- Realtime preview of the migration files
-- Better frontend validation
+![](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.48.21.jpg)
+
+It will generate a migration file:
+
+![](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.48.51.jpg)
+
+### Create another model
+
+Now, we add a `Book` model:
+
+![](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.50.04.jpg)
+
+### All the migrations generated
+
+![](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.50.19.jpg)
+
+### Files generated
+
+Every action made from the UI will generate native Rails migration files.
+Exactly like the `rails generate` command.
+But instead of generating files in the console, they are generated in the `db/migrate` folder.
+
+- The models:
+![](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.51.47.jpg)
+![](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.51.48.jpg)
+
+- The migration files:
+![](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.52.18.jpg)
+![](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.52.26.jpg)
+
+- The final schema:
+![](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v2.0.0/Screenshot%202024-11-18%20at%2022.52.38.jpg)
+
+
+## Upgrading
+
+I recommend you to upgrade to the latest version which is `2.0.0`.
+To upgrade, just use the latest version of Localtower.
+You have nothing else to do.
+
+```
+bundle update localtower
+```
+
+## Contribute
+
+Thanks for reporting issues, I'll do my best to fix the bugs 💪
+
+![ga](https://www.google-analytics.com/collect?v=1&tid=G-1XG3EBE2DZ&cid=555&aip=1&t=event&ec=github&ea=visit&dp=readme&dt=gem)
 
 ## Run test
 
@@ -90,29 +181,38 @@ LOCALTOWER_PG_USERNAME="admin"
 LOCALTOWER_PG_PASSWORD="root_or_smething"
 ```
 
+drop / create database:
+
+```bash
+cd spec/dummy
+bundle exec rails db:drop
+bundle exec rails db:create
+rm app/models/*.rb
+```
+
 Run the spec:
+
 ```bash
 bundle install
 bundle exec rspec spec/
 ```
 
-## Contribute
-
-Thanks for reporting issues, I'll do my best to fix the bugs 💪
-
-![ga](https://www.google-analytics.com/collect?v=1&tid=G-1XG3EBE2DZ&cid=555&aip=1&t=event&ec=github&ea=visit&dp=readme&dt=gem)
-
-## Deploy
+## Deploy latest gem version
 
 Only for official contributors.
 
-    rm *.gem | gem build localtower.gemspec && gem push localtower-*.gem
+    git tag vX.X.X # change by last version
+    git push --tags
+    rm *.gem
+    gem build localtower.gemspec
+    gem push localtower-*.gem
 
 ## Notes
 
 Do not hesitate to open issues if you have troubles using the gem.
 
-- By Damian Le Nouaille Diez: https://damln.com
-- Supported by Explicit Ruby: https://explicit-ruby.run
+- By Damian Le Nouaille:
+  - Twitter: https://twitter.com/damian_lnd
+  - Website: https://damln.com
 - Link on RubyGems.org: https://rubygems.org/gems/localtower
-- Stats on BestGems.org: https://bestgems.org/gems/localtower
+- Stats on BestGems.org (30k+ downloads): https://bestgems.org/gems/localtower