Skip to main content

CM Admin

An admin gem for Ruby on Rails application. Get your admin panel setup running quickly.

Installation​

Add this line to your application's Gemfile:

gem 'cm-admin'

And then execute:

bundle install

Or install it yourself as:

gem install cm-admin

Usage​

Install the gem

rails g cm_admin:install

Demo​

For demo check here For demo repo check here

Development​

For local development setup and connecting cm-admin to other local Rails apps, check the Catalyst Setup Guide.

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

Any markdown inside docs-site/docs/ folder will be auto added in CM Docs.

Deployment​

To release a new version of the Gem you can use Github Actions.

Go to Actions tab in your repository and click on Bump Gem workflow. You will see Run workflow button click on it and choose Bump Type, then click Run Workflow and it will bump the version of the gem and push the changes to the repository.

Docs for AI Coding Agents​

These docs are available in two agent-friendly forms:

  • Bundled with the gem. The Markdown source of these docs ships inside cm-admin, so they always match the installed version. Find them with:

    echo "$(bundle show cm-admin)/docs-site/docs"

  • On the website. /llms.txt indexes every page, /llms-full.txt contains all docs in one file, and each page has a Markdown version at its URL plus .md (for example, /docs/Views/IndexDsl.md).

Prefer the bundled docs: they need no network access and match the version in your Gemfile.lock.

Contributing​

Bug reports and pull requests are welcome on GitHub.

License​

The gem is available as open source under the terms of the MIT License.