cra-template-pwa-starter

PWA Starter

This application is a react starter application used by DHA developers for developing progressive web applications

This project was bootstrapped with Create React App. You can find more information about getting started with Create React App here, and available scripts here.

Release Notes for the pwa-starter

See CHANGELOG.md for revision history

Table of Contents

• PWA Starter
• Release Notes / Version History
• Table of Contents
• Quick Start
• New Project Instructions
• Developer Notes
• DHA SDK Packages
• Built With
• Available Scripts
  • npm start
  • npm test
  • npm run test:ci
  • npm run test:coverage
  • npm run build
  • npm run eject
  • npm run format
  • npm run lint
• Testing
• List of Current Analytics Pages and Events Tracked
  • Pages Tracked in the PWA-Starter
  • Events tracked in the PWA-Starter
• Create React App Template Specifics
  • Starting a New Project Utilizing the Template

Quick Start

For starting new projects use the commands below and follow New Project Instructions

• npx create-react-app app-name-here --template pwa-starter
• cd app-name-here
• npm start

For updating and maintaining PWA Starter

New Project Instructions

• npx create-react-app app-name-here --template pwa-starter

• .gitignore

  • Uncomment build folder if its not needed in the repository for CI/CD or hosting.

• package.json

  • Add or replace the values for: name, version, author, description, repository.url, and bug.url.

• Copyright Headers

  • Add copyright headers to every new file.
  • Add the file name on the first line.
  • Add the file description on the second line
  • Replace firstName, lastName, and date for the line "Created by firstName lastName on date".
    • Search and replace all instances of "pwa-starter" with your application name in all project files.

Developer Notes

Look at the repository wiki for extra developer information.

DHA SDK Packages

The application uses the following DHA SDK packages:

• dha-analytics
• dha-dexie-encrypted
• dha-encryption
• dha-rating

Built With

• Create React App.
• React
• Material UI
• Typescript

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run test:ci

Launches the test runner in non-interactive watch mode. This script lets the ci and build complete without any other interactions when running.

npm run test:coverage

Launches the test runner in the interactive watch mode. This will generate the test coverage report in the coverage folder and viewed in the console.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

npm run format

Runs Prettier to format project files. Prettier doesn't have a parser for every file extension. If you get the error "No parser could be inferred for file: file.png", add the file or extension to .prettierignore.

npm run lint

Runs TSLint to check for linting errors in project files.

Testing

• Tests can be ran with the npm test command
• Tests are ran using Jest with enzyme - More information about getting started with jest can be found here
• Example Render Test

it('renders without crashing', () => {
    shallow(<Home/>);
});`

List of Current Analytics Pages and Events Tracked

Pages Tracked in the PWA-Starter

1. About
2. EULA
3. FAQ
4. Feedback
5. Home
6. Account Setup
7. Login
8. Logout
9. New Pin
10. Pin Reset
11. Page Not Found
12. Resources
13. Settings
14. Sitemap

Events Tracked in the PWA-Starter

1. When you change the feedback subject line.
2. When you change the feedback body line.
3. When you submit the changes to the feedback.
4. When you increment the count on the homepage.