Skip to content

Latest commit

 

History

History
106 lines (68 loc) · 3.05 KB

README.md

File metadata and controls

106 lines (68 loc) · 3.05 KB

hosted-web-integration

Staging Status Production Status

Overview

This repository provides a self-hosted integration for Smile ID on the Web. It encompasses a comprehensive set of utilities for KYC processes, biometric verification, and more. Public documentation here.

Prerequisites

Setup

  1. Clone the repository:

    git clone https://github.com/smileidentity/hosted-web-integration.git
cd hosted-web-integration

  2. Switch to the appropriate Node version using nvm:

    nvm install
nvm use

  3. Install project dependencies:

    npm install

Running the Project

  1. Build the project:

    npm run build

  2. Start the local server:

    npm start

  3. Access the application on http://localhost:8000.

Configuration

  • .git-blame-ignore-revs: File used to ignore certain commits in git blame.
  • .gitignore: Specifies files to ignore in git. These include ./dist and ./build.
  • .nvmrc: Node Version Manager configuration file.
  • .nycrc: NYC configuration file.
  • esbuild.js: esbuild configuration file.

Testing

Run Cypress tests using:

npm test

NOTE: the npm start command must be running in a separate terminal window.

Cypress Configuration & Pages

  • cypress.config.js: Main Cypress configuration file.
  • cypress/pages/: Contains all the utility pages.

Creating a Release

When you're ready to create a new release for this project, follow the steps below:

  1. Bump the version in the package.json file:

    You can do this manually or use npm commands to update the version. For example, to bump a patch:

    npm version patch

    This will increase the patch version (e.g., from v1.0.0 to v1.0.1). Similarly, you can use npm version minor or npm version major for minor and major version bumps respectively.

  2. Commit the change:

    If you used the npm version command, it will automatically commit the change for you with a commit message like "1.0.1". If you updated the package.json file manually, ensure you commit the change:

    git add package.json
git commit -m "Bump version to [NEW_VERSION]"

  3. Push a new tag:

    Tag the new commit with the version number and push the tag to the repository:

    git tag v[NEW_VERSION]
git push origin v[NEW_VERSION]