Archangel

** Archangel is currently under development. It is not ready for production use. **

Archangel is a Rails CMS.

This project rocks and uses MIT-LICENSE.

Online documentation is available

Deploying to Heroku

Deploy a sample application to Heroku to play with.

Requirements

• Ruby >= 2.2.10
• Rails ~> 5.1

Installation

Add to your application's Gemfile

gem "archangel"

Run the bundle command

$ bundle install

Run the install generator

$ bundle exec rails g archangel:install

Run the install generator with seed data

$ bundle exec rails g archangel:install --seed

Seed data can be created separately by running rake db:seed

Updating

Subsequent updates can be done by bumping the version in your application Gemfile, then installing new migrations

$ bundle exec rails archangel:install:migrations

Run migrations

$ bundle exec rails db:migrate

Code Analysis

• Travis CI is used for running tests.
• Hound is used as the code analyzer in pull request.
• Code Climate is used to analyze overall maintainability.

Developers

General documentation for developers

• Contributing Guide
• Documentation for Archangel gem developers
• Documentation for extension developers
• Documentation for theme developers
• Documentation for releasing a gem version (maintainers only)

Logo

Archangel's logo was created by Joshua Boyd.

Special Thanks

@archangel-dlt originally had the "archangel" gem name and were kind enough to give it up

Contributing

A contributing guide is available.

1. Fork it (https://github.com/archangel/archangel/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request