Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kbravh/scriptly-redux
A site that will format patriarchal blessings to make them look like pages from the scriptures.
https://github.com/kbravh/scriptly-redux
blessings lds scripture
Last synced: 13 days ago
JSON representation
A site that will format patriarchal blessings to make them look like pages from the scriptures.
- Host: GitHub
- URL: https://github.com/kbravh/scriptly-redux
- Owner: kbravh
- License: mit
- Created: 2020-01-17T19:36:34.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-11-10T10:47:50.000Z (about 1 year ago)
- Last Synced: 2024-12-01T12:55:35.939Z (21 days ago)
- Topics: blessings, lds, scripture
- Language: JavaScript
- Homepage: https://scripture.page
- Size: 20.4 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Scriptly
[](https://app.netlify.com/sites/scripture/deploys)
Welcome to Scriptly, a site designed to produce scripture-styled patriarchal blessings. [What's a patriarchal blessing?](https://www.churchofjesuschrist.org/study/manual/gospel-topics/patriarchal-blessings)
# Local Development
In order to run the site locally, clone this repository then install all dependencies using either `yarn install` or `npm install`. Finally, run `gatsby develop`. Visit https://localhost:8000 to see the site.
To run tests, run `npm run test` which will kick off the Jest testing suite. Note: Currently, there are only unit tests.
# Site breakdown
This site is made up of multiple components:
* Frontend - Built on [GatsbyJS](https://gatsbyjs.org), a React based website building framework
* Backend - Two Node.js functions hosted on AWS Lambda
## Frontend
The frontend code makes up the majority of this repository.
```
.
├── __mocks__
│ ├── file-mock.js
│ └── gatsby.js
├── src
│ ├── components
│ │ ├── __tests__
│ │ ├── css
│ │ └── ...
│ ├── images
│ ├── intl
│ ├── machines
│ └── pages
├── static
├── gatsby-config.js
├── jest-preprocess.js
├── jest.config.js
└── loadershim.js
```
The `__mocks__` directory and `jest-preprocess.js`, `jest.config.js`, and `loadershim.js` files are all used for testing. The tests themselves are in the `__tests__` directory. See [Gatsby testing](https://www.gatsbyjs.org/docs/testing/) for more information about this setup.
Overall site flow and logic is handled by an [xState](https://github.com/davidkpiano/xstate) state machine, located in the `machines` directory.
The `pages` directory contains React components that will be turned into pages on build, while the `components` are used in those pages across the site.
Internationalization is handled by [react-intl](https://github.com/yahoo/react-intl), with translations located in the `intl` directory. The site is currently available in the following languages:
* English
* Spanish
Would you like to help translate to a new language? Get in touch!
## Backend
The backend functions are at the root level of the repository in these folders.
```
.
├── scriptly-docx-lambda
└── scriptly-pdf-lambda
```
Once the user posts their form data, it is sent over to the `scriptly-docx-lambda` function. This function has docx templates which are populated with the user's data by the [docxtemplater](https://github.com/open-xml-templating/docxtemplater) library. After the docx is created, the `scriptly-pdf-lambda` function is called. It picks up the docx file from S3 and converts it to a PDF using a headless OpenOffice in Lambda.
# Todo
* Visual testing using Jest or Cypress
* OCR/text-recognition so that users can upload PDF versions of their blessings instead of typing them
* A completely client-side method for creating the scripture pages