rails_lens
Comprehensive Rails application visualization and annotation tool - precision optics for the Rails universe
File Explorer
Download Latest Version (.zip)- ci.yml
- release-please.yml
- console
- rails
- setup
- rails_lens
- association_analyzer.rb
- base.rb
- best_practices_analyzer.rb
- callbacks.rb
- column_analyzer.rb
- composite_keys.rb
- database_constraints.rb
- delegated_types.rb
- enums.rb
- error_handling.rb
- foreign_key_analyzer.rb
- generated_columns.rb
- index_analyzer.rb
- inheritance.rb
- notes.rb
- performance_analyzer.rb
- column_type_formatter.rb
- domain_color_mapper.rb
- mysql_column_type_formatter.rb
- postgresql_column_type_formatter.rb
- visualizer.rb
- base.rb
- closure_tree_ext.rb
- annotator.rb
- extractor.rb
- active_record_source.rb
- class_info.rb
- module_info.rb
- node_info.rb
- parser_result.rb
- prism_parser.rb
- association_notes_provider.rb
- base.rb
- best_practices_notes_provider.rb
- callbacks_provider.rb
- column_notes_provider.rb
- composite_keys_provider.rb
- database_constraints_provider.rb
- delegated_types_provider.rb
- enums_provider.rb
- extension_notes_provider.rb
- extensions_provider.rb
- foreign_key_notes_provider.rb
- generated_columns_provider.rb
- index_notes_provider.rb
- inheritance_provider.rb
- notes_provider_base.rb
- performance_notes_provider.rb
- schema_provider.rb
- section_provider_base.rb
- view_notes_provider.rb
- view_provider.rb
- annotator.rb
- extractor.rb
- parser.rb
- base.rb
- database_info.rb
- mysql.rb
- postgresql.rb
- sqlite3.rb
- annotation.rb
- annotation_manager.rb
- annotation_removal.rb
- database_annotator.rb
- annotate.rake
- erd.rake
- mailers.rake
- routes.rake
- schema.rake
- annotation_pipeline.rb
- cli.rb
- cli_error_handler.rb
- commands.rb
- configuration.rb
- connection.rb
- errors.rb
- extension_loader.rb
- file_insertion_helper.rb
- model_detector.rb
- model_source.rb
- model_source_loader.rb
- note_codes.rb
- parsers.rb
- railtie.rb
- rake_bootstrapper.rb
- toml_format.rb
- version.rb
- view_metadata.rb
- rails_lens.rb
- application_controller.rb
- crew_members_controller.rb
- health_controller.rb
- spaceships_controller.rb
- test_controller.rb
- application_mailer.rb
- crew_mailer.rb
- spaceship_mailer.rb
- auditable.rb
- entryable.rb
- trackable.rb
- active_crew_members_view.rb
- alert.rb
- announcement.rb
- application_record.rb
- audit_log.rb
- cargo_vessel.rb
- comment.rb
- crew_member.rb
- crew_mission_stats.rb
- diet_relationship.rb
- dinosaur.rb
- entry.rb
- excavation_site.rb
- family.rb
- forgotten_war.rb
- fossil_discovery.rb
- fossil_discovery_timeline.rb
- home_planet.rb
- maintenance_record.rb
- manufacturer.rb
- message.rb
- mission.rb
- mission_waypoint.rb
- order_line_item.rb
- owner.rb
- post.rb
- prehistoric_record.rb
- product.rb
- product_metric.rb
- spaceship.rb
- spaceship_crew_member.rb
- spaceship_stats_view.rb
- spatial_analysis.rb
- spatial_coordinate.rb
- species.rb
- starfleet_battle_cruiser.rb
- tenant_setting.rb
- trigger.rb
- trip.rb
- user.rb
- vehicle.rb
- vehicle_owner.rb
- vehicle_performance_metrics.rb
- vehicle_record.rb
- welcome_aboard.html.erb
- mission_assignment.html.erb
- mission_assignment.text.erb
- rails
- development.rb
- test.rb
- multi_database.rb
- application.rb
- boot.rb
- database.yml
- environment.rb
- routes.rb
- prehistoric_schema.rb
- schema.rb
- vehicles_schema.rb
- crew_members.yml
- dinosaurs.yml
- entries.yml
- families.yml
- forgotten_wars.yml
- home_planets.yml
- manufacturers.yml
- owners.yml
- spaceships.yml
- species.yml
- starfleet_battle_cruisers.yml
- vehicles.yml
- .rails-lens.yml
- config.ru
- Rakefile
- abstract_class_and_connection_test.rb
- annotation_rake_task_test.rb
- cross_database_relationships_test.rb
- database_specific_features_test.rb
- dummy_app_test.rb
- multi_database_annotation_rake_task_test.rb
- multi_database_annotation_test.rb
- multi_database_scenarios_test.rb
- trigger_function_annotation_test.rb
- prism_parser_test.rb
- best_practices_analyzer_test.rb
- callbacks_test.rb
- composite_keys_test.rb
- delegated_types_test.rb
- enums_test.rb
- index_analyzer_test.rb
- inheritance_test.rb
- notes_test.rb
- annotator_test.rb
- visualizer_test.rb
- closure_tree_ext_test.rb
- base_test.rb
- mysql_test.rb
- postgresql_test.rb
- sqlite3_test.rb
- annotation_idempotence_test.rb
- annotation_manager_source_filter_test.rb
- annotation_pipeline_test.rb
- cli_test.rb
- connection_pooling_test.rb
- edge_cases_test.rb
- error_handling_test.rb
- lens_test.rb
- model_detector_test.rb
- toml_format_test.rb
- view_metadata_test.rb
- end_to_end_annotation_test.rb
- file_insertion_helper_test.rb
- practical_annotation_test.rb
- test_helper.rb
- .gitignore
- .release-please-manifest.json
- .rubocop.yml
- .ruby-version
- CHANGELOG.md
- COMPARISON.md
- Gemfile
- LICENSE.txt
- rails_lens.gemspec
- Rakefile
- README.md
- release-please-config.json
# Installation Guide
1. Get the code
git clone https://github.com/seuros/rails_lens
Downloads the entire project code from GitHub to your computer.
cd rails_lens
Moves into the project folder you just downloaded.
2. Ruby
Easy RecommendedPrerequisites
bundle install
Installs the Ruby libraries listed in the Gemfile.
bundle exec rails_lens install
Type this command into your terminal and run it.
bundle exec rails_lens annotate
Type this command into your terminal and run it.
bundle exec rails_lens annotate --models User Post
Type this command into your terminal and run it.
bundle exec rails_lens annotate --include-abstract
Type this command into your terminal and run it.
If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)