Skip to content

unfoldingWord/door43-preview-app

Repository files navigation


Logo

Door43 Preview

DCS resources preview

The app is available here

Report Bug · Request Feature

Open Components Ecosystem Discord license


Features

  • Offering an easy to use app for printing Bible text and Bible Stories.
  • The various underlying components are assembled together in a simple user interface.
  • Most of the features are made available from the underlying components, meaning that the size of code in this app is kept rather small.

Support

Having trouble? Get help in the official Open Components Ecosystem Discord.


About The Project

Door43 Preview Screenshot

Purpose

This app is basically just a wrapper for other components (a reference implementation app).

These are some of the underlying components:

  • Epitelete-html HTML handling in Epitelete - as a derived sub-class. All the original Epitelete parent functions are inherited and then extended with more functions for generating and parsing Html.

  • proskomma-core An implementation of the Proskomma Scripture Processing Model.

(back to top)

Built With

(back to top)

Roadmap

See the open issues for a full list of proposed features (and any known issues).

(back to top)

Contributing

The open source community is an amazing place to learn, inspire, and create. So, any contributions you make are greatly appreciated. Guidelines for rcl development and general information.

You can, for instance, simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

If you would like to fork the repo and create a pull request.

  1. Fork the Project

  2. Clone the repo

    git clone https://github.com/unfoldingWord-box3/door43-preview-app.git
  3. Install packages

    pnpm install
  4. Run locally:

    pnpm run dev
  5. Create your Feature Branch (git checkout -b feature/AmazingFeature)

  6. Commit your Changes (git commit -m 'Add some AmazingFeature')

  7. Push to the Branch (git push origin feature/AmazingFeature)

  8. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)