https://github.com/thombruce/helvellyn

An open source headless CMS with a customisable JSON API
https://github.com/thombruce/helvellyn

api blogging cms headless jamstack json open-source rails ruby vue vuetify web-application

Last synced: 27 days ago
JSON representation

An open source headless CMS with a customisable JSON API

• Host: GitHub
• URL: https://github.com/thombruce/helvellyn
• Owner: thombruce
• License: mit
• Created: 2020-03-04T20:38:24.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T02:37:10.000Z (about 2 years ago)
• Last Synced: 2024-10-27T23:51:27.498Z (3 months ago)
• Topics: api, blogging, cms, headless, jamstack, json, open-source, rails, ruby, vue, vuetify, web-application
• Language: Ruby
• Homepage:
• Size: 2.01 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 48
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
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](#getting-started)

2. [Development](#development)

3. [Testing](#testing)

4. [Sponsors](#sponsors)

5. [Maintainers](#maintainers)

6. [Contributors](#contributors)

7. [Todo](#todo)

## Getting Started

```shell

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:

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## Development

![GitHub Flow](https://i.imgur.com/zE06Jon.png)

Helvellyn devlopment uses [GitHub Flow](https://guides.github.com/introduction/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

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/thombruce/helvellyn/CI?logo=github)](https://github.com/thombruce/helvellyn/actions)

[![Codecov](https://img.shields.io/codecov/c/github/thombruce/helvellyn?logo=codecov)](https://codecov.io/gh/thombruce/helvellyn)

```shell

bundle exec rspec

```

*You may need to install [Chromedriver](https://chromedriver.chromium.org/) to run system specs.*

To exclude system specs from the test run:

```shell

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

```

## Sponsors

[![Become a Patron](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/thombruce)

Details about how you can sponsor the project to follow.

_Sponsors will be listed here._

## Maintainers

[![thombruce](https://avatars1.githubusercontent.com/u/3887509?s=60&v=4)](https://github.com/thombruce)

## Contributors

_Significant contributors will be listed here._

## Todo

[![GitHub issues](https://img.shields.io/github/issues-raw/thombruce/helvellyn?logo=github)](https://github.com/thombruce/helvellyn/issues)

- [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](https://github.com/thombruce/credible)

    - ~~HelvellynJS~~ - See: [Helvellyn.js](https://github.com/thombruce/helvellyn.js)