https://github.com/steveszc/catechesis

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

catechism christianity ember open-source

Last synced: 2 months ago
JSON representation

Open-source catechism web viewer

• Host: GitHub
• URL: https://github.com/steveszc/catechesis
• Owner: steveszc
• Created: 2022-07-30T04:54:29.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-05T03:33:12.000Z (over 1 year ago)
• Last Synced: 2024-10-01T08:41:56.797Z (3 months ago)
• Topics: catechism, christianity, ember, open-source
• Language: TypeScript
• Homepage: https://www.catechesis.app
• Size: 11.3 MB
• Stars: 8
• Watchers: 1
• Forks: 2
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

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/)