Helvellyn

Helvellyn | Helvellyn.js | Credible

A Ruby on Rails based content management system that exposes a customisable API for publishing content.

Table of Contents

1. Getting Started
2. Development
3. Testing
4. Sponsors
5. Maintainers
6. Contributors
7. Todo

Getting Started

git clone https://github.com/thombruce/helvellyn.git
cd helvellyn
rake db:setup
rails s

Quick Deploy to Heroku

Alternatively, you can launch the app immediately with just the click of a button:

Development

Helvellyn devlopment uses GitHub Flow, which is a very minimalist approach to Git flow. The master branch is always production-code, ready to deploy. Code that is in development is reviewed in isolation on its own feature branch and its related pull request before being merged to master.

Testing

bundle exec rspec

You may need to install Chromedriver to run system specs.

To exclude system specs from the test run:

bundle exec rspec --exclude-pattern "spec/system/**/*.rb"

Sponsors

Details about how you can sponsor the project to follow.

Sponsors will be listed here.

Maintainers

Contributors

Significant contributors will be listed here.

Todo

• [x] GitHub Actions
• [x] Heroku Review Apps
• [x] Coverage Reporting
• [ ] Achieve min. coverage of 80%
• [ ] Separation into engines/packages:
  • Helvellyn::Admin - Admin API for Helvellyn CMS
  • Helvellyn::Api - Public API for Helvellyn CMS
  • Helvellyn::Auth - See: Credible
  • HelvellynJS - See: Helvellyn.js