gateway-edit

Main: Develop:

Book Package harmonized view.

Staging Environment URLs

• Production: https://gatewayedit.com or https://gateway-edit.netlify.app/
• Develop: https://develop--gateway-edit.netlify.app/
• Release-v0.9.0 https://release-v0-9-0--gateway-edit.netlify.app/
• Release-v1.0.0 https://release-v1-0-0--gateway-edit.netlify.app/
• Release-v2.1.0 https://release-v2-1-0--gateway-edit.netlify.app/

Local Testing

Running the app locally

Run:

yarn && yarn dev

Then open browser to http://localhost:3000/ to run the app.

Testing Nextjs build

First delete the .next and out folders. And then run:

yarn && yarn build

Then should see that the .next and out folders are created. The out folder should have index.html file.

Running tests

• Before running any tests, make sure initialized by doing:

yarn

• also before running cypress tests, you must create a file cypress.env.json with contents such as (of course replace text in << >> with you user login credentials):

{
  "TEST_USERNAME": <<my user name>>,
  "TEST_PASSWORD": <<my user password>>
}

Running Jest Unit Tests

yarn run test:unit

Running Cypress tests Interactively

• in first terminal, start the app by (in Windows, run this in git Bash as it needs bash):

yarn dev

• then in second terminal, to run cypress interactively do:

yarn run cypress

Electronite Testing

• in console run window.location="http://localhost:3000/"

Running Cypress tests headless

• in terminal, start the app by (in Windows, run this in git Bash as it needs bash):

yarn test:headless

Scripts

• "report:combined": combines Cypress & Jest test coverage reports into one coverage report.

Storage

Application General

• stored in localStorage under username
• allignment data is stored in indexedDB ('app-state', 'dataStore')
• lexicon is cached in indexedDB gloss-store

GateWay Edit Electronite App:

Building:

• see scripts in package.json
  • example mac build: yarn run mac:build-gwe-universal-install
• Intermediate build folder: ./scripts/gatewayedit-desktop
• Final installs are in folder: ./dist

Upgrading Electronite:

• update electron and electronite versions in devDependencies (note that electronite has -graphite extension):
  • MacOs: scripts/mac-build/package.json
  • Windows: scripts/win-build/package.json
• also bump version number in the above files

UI Design

• Structure of the React components in this app

Application (in pages/_app.js) contains:

• AuthContext context
• StoreContext context:

Home (in pages/index.js) contains:

WorkspaceContainer component manages the Resource workspace

• Contains Workspace component (resource workspace rcl) that contains several:
  • ScriptureCard components
  • ResourceCard components

Layout component:

• accesses authentication context and store context
• Manages server selection through url variables
• Displays Onboarding component if login is required
• Contains the header and footer

BibleReference component:

• Uses bible Reference RCL
• Updates reference store context

Onboarding component

• Displays the AccountSetup component when login is required

Header component:

• Contains BibleReference component

Footer component:

• Shows app version/build

Drawer component (hamburger menu):

• Shows

TranslationSettings component:

• Prompts for organization and language

ResourceCard component:

• Card that displays translationHelps content

ScriptureCard component:

• Card that displays scripture content

AuthContext context:

• Initializes the authentication context (defined in gitea-react-toolkit)

StoreContext context:

• Manages and persists application state data into local storage

useLocalStorage - custom hook that persists generic application data into local storage

useUserLocalStorage - custom hook that application data for logged in user into local storage