Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 3.36 KB

README.md

File metadata and controls

73 lines (46 loc) · 3.36 KB
Raw

📈 Onboarding client

  1. Client for Tuleva onboarding

CircleCI codecov

Tech evolution

Originally, this repo was built using js, redux and enzyme for testing. Over the years react has grown, rendering some of these tehcnologies less useful. This architecture has shown itself to be overcomplicated and the current tests to not give as much value as they could. Thus, whenever you are working on new functionality in this repo, try to do the following:

  • Convert files you touch to typescript, this can be easily done as typescript and js can be used interchangably in this repo
  • Try to not use redux, or if you need to use it try to keep it far away from your code in a generic hook, use simple hooks for logic and React Query for async data fetching boilerplate. Use React's native context for localized state sharing, example in withdrawals/hooks.ts.
  • Use react testing library and msw for tests and try to mock as little as possible, building tests to imitate how a user would use your application. See the CancellationFlow for an example of how to incrementally move to this structure while reusing previous redux code.

Prerequisites

  • Git
  • Node.js LTS (20.14.0) and NPM (10.7.0)

Easiest way to get a specific version of Nodejs (or almost anything really) is to use asdf

  • asdf plugin add nodejs
  • asdf install nodejs

Development

To develop the onboarding app:

  1. Install dependencies
npm install
  1. Run the local server
npm run develop

Or alternatively, when running against production, switch the proxy field in package.json against the production server, and run:

npm run develop-production
  1. Run tests
npm test

onboarding-service is expected to run on port 9000 when not running against production.

Development against the production service (https://onboarding-service.tuleva.ee)

  1. Point the proxy server to production in package.json: "proxy": "https://onboarding-service.tuleva.ee"
  2. npm run develop-production
  3. If chrome won't open the page due to a certificate error, type: thisisunsafe

Deployment

Updating the inline widget is manual, so the bundles need to be created locally, uploaded to the Zone FTP server, and the URLs in wordpress-theme updated.

The onboarding client itself is deployed to AWS on master push (through CircleCI).

Updating Nodejs

We stay on the LTS version of Nodejs. When that changes, the version can be updated by:

  • Updating the version in package.json engines property (set the upper limit to the next major version).
  • Updating the version in .circleci/config tag node/default value to make the CI pipeline use the right version.
  • Updating the version in .tool-versions (used by asdf)