Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/steveszc/catechesis

Open-source catechism web viewer
https://github.com/steveszc/catechesis

catechism christianity ember open-source

Last synced: 23 days ago
JSON representation

Open-source catechism web viewer

Awesome Lists containing this project

README

        

# Catechesis

[![CI](https://github.com/steveszc/catechesis/actions/workflows/ci.yml/badge.svg)](https://github.com/steveszc/catechesis/actions/workflows/ci.yml)

This README outlines the details of collaborating on this Ember application.

Catechesis is an open source catechism viewer application.

## Prerequisites

You will need the following things properly installed on your computer.

* [Git](https://git-scm.com/)
* [Node.js](https://nodejs.org/) (with npm)
* [Ember CLI](https://cli.emberjs.com/release/)
* [Google Chrome](https://google.com/chrome/)

## Installation

* `git clone https://github.com/steveszc/catechesis.git` this repository
* `cd catechesis`
* `npm install`

## Running / Development

* `npm start`
* `npm run glint` to run typechecking
* Visit your app at [http://localhost:4200](http://localhost:4200).
* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).

### Code Generators

Make use of the many generators for code, try `ember help generate` for more details

### Running Tests

* `ember test`
* `ember test --server`

### Linting

* `npm run lint`
* `npm run lint:fix`

### Building

* `ember build` (development)
* `ember build --environment production` (production)

### Deploying

Currently deployed to Github pages via GH Actions. See `gh-pages` branch.

## Further Reading / Useful Links

* [ember.js](https://emberjs.com/)
* [ember-cli](https://cli.emberjs.com/release/)
* Development Browser Extensions
* [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
* [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)