Open Source · MIT License

The missing bridge between your backend & frontend team

Stop wasting hours explaining your Rails API to frontend developers. RailsMap automatically maps your routes, controllers, and models into beautiful, interactive documentation that everyone can understand.

Zero
Configuration
30 sec
Setup Time
100%
Automatic
💎
Backend
Rails API
🗺️
Bridge
RailsMap
⚛️
Frontend
React / Angular
🛣️
Routes
🎮
Controllers
📊
Models

Sound familiar?

Every Rails developer knows the pain. Your backend is powerful, but getting the frontend team on the same page feels impossible.

😩

"What endpoints do we have?"

Frontend devs constantly asking about available routes, required params, and response formats. You spend more time explaining than coding.

📝

Documentation is always outdated

You wrote docs once, then the API changed. Now nobody trusts them, and you're back to Slack messages and screen shares.

🔄

Constant context switching

Every time someone needs API info, you have to stop what you're doing, dig through controllers, and piece together the answer.

🤷

"What columns does this model have?"

New team members struggle to understand your data structure. They open migration files, check schemas, ask questions...

RailsMap does the work for you

Install once, forget forever. Your API documentation stays in sync automatically.

🛣️

Automatic Route Discovery

Every route in your Rails app is automatically discovered and documented. HTTP methods, paths, constraints, and route names—all mapped instantly.

GET / POST / PUT / DELETE Route Params Constraints
📊

Model Introspection

Database columns, associations, validations, and scopes are extracted automatically. Your data structure, documented without writing a single line.

Columns & Types Associations Validations
🎨

Beautiful Dark UI

Modern, responsive interface that developers actually want to use. Searchable, filterable, and easy to navigate. Looks great on any device.

Dark Theme Instant Search Responsive
🔒

Environment-Based Auth

Secure by default with environment variables. No database, no migrations—just set RAILS_MAP_USERNAME and RAILS_MAP_PASSWORD. Defaults to admin/password.

No Database ENV Variables Default Credentials

Zero Configuration

Run one command. That's it. No config files, no annotations, no comments. RailsMap reads your code and generates docs automatically.

One Command Auto-mount Works Instantly
🔄

Always In Sync

Add a route? It's documented. Change a model? Updated automatically. Your docs are always current because they come from your actual code.

Live Updates No Manual Work Always Accurate

See what your team will see

A clean, organized view of your entire Rails API. No more digging through code.

localhost:3000/rails-map
Dashboard Routes Models
15
Controllers
67
Routes
12
Models
Api::V1::UsersController 7 routes
/api/v1/users · index, show, create, update, destroy
Api::V1::PostsController 5 routes
/api/v1/posts · index, show, create, update, destroy
User 8 columns
has_many :posts, has_many :comments
Post 6 columns
belongs_to :user, has_many :comments

Up and running in 30 seconds

Seriously. Three commands and you're done.

1

Add RailsMap to your Gemfile

Just one line. That's all you need to add.

# Gemfile
gem 'rails_map'
2

Run the install generator

This mounts the engine and creates the config. Set environment variables to customize credentials (defaults: admin/password).

$ bundle install
$ rails generate rails_map:install
# Optional: export RAILS_MAP_USERNAME=your_user
# Optional: export RAILS_MAP_PASSWORD=your_pass
3

Visit your docs

Start your server and open the documentation URL. Login with default credentials: admin/password

$ rails server
# Open http://localhost:3000/rails-map
# Default: username=admin, password=password

Stop explaining. Start shipping.

Give your team the documentation they need. Install RailsMap today and bridge the gap between backend and frontend—permanently.

gem install rails_map