Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 1.89 KB

README.md

File metadata and controls

73 lines (48 loc) · 1.89 KB

Solidus Cms

CircleCI codecov

Installation

Add solidus_cms to your Gemfile:

gem 'solidus_cms'

Bundle your dependencies and run the installation generator:

bin/rails generate solidus_cms:install

Usage

Development

Testing the extension

First bundle your dependencies, then run bin/rake. bin/rake will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using bin/rake extension:test_app.

bin/rake

To run Rubocop static code analysis run

bundle exec rubocop

When testing your application's integration with this extension you may use its factories. You can load Solidus core factories along with this extension's factories using this statement:

SolidusDevSupport::TestingSupport::Factories.load_for(SolidusCms::Engine)

Running the sandbox

To run this extension in a sandboxed Solidus application, you can run bin/sandbox. The path for the sandbox app is ./sandbox and bin/rails will forward any Rails commands to sandbox/bin/rails.

Here's an example:

$ bin/rails server
=> Booting Puma
=> Rails 6.0.2.1 application starting in development
* Listening on tcp://127.0.0.1:3000
Use Ctrl-C to stop

Releasing new versions

Please refer to the dedicated page in the Solidus wiki.

License

Copyright (c) 2024 Kevin Perez, released under the New BSD License.