Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 2.91 KB

README.md

File metadata and controls

73 lines (47 loc) · 2.91 KB
Raw

CICD

Loan Quote Widget

Embed the loan quote widget in your e-commerce to show your customer how much they're going to pay with Soisy's instalments. The embedding instructions are written in our official documentation.

This repository is open-source so that, those who needs, could download it and customize their own version. This software is provided under the Mozilla Public License 2.0. Please check section 6 of the license.

Requirements if you want to test locally

Please note that this project uses Docker for development and CI/CD. Therefore it is mandatory to have docker and docker-compose installed in your local environment.

Local installation

If you simply want to embed the widget in your page please refer to our official documentation.
If you want to have your own local copy, then please read further.

To install the widget's source locally please follow these instructions:

  • Git clone this repo to your local development environment
  • cd to the root of the project
  • Run $ cd .docker to go to the sub-directory where all the Docker's config files are.
  • Run $ ./up. This will take several minutes the first time, so don't be afraid to wait a little 😜

Navigate in your browser

You can check your local widget running at this address http://localhost:4200.

NOTE: If the address above doesn't give you a response please note that the npm i command may still be installing and building something up. Wait another couple of minutes and you'll see everything's working.

Running tests

This project uses NX as tool for development.
You can execute the test suite by running

$ nx test

inside your docker container.

Refer to NX documentation or run nx test --help if you need more info.

Smoke tests

Our test suite is not 100% accurate and some smoke test should be performed before releasing to prod. Right now there is no automated smoke test, but you can use smoke-test.html web page to perform some manual smoke testing.

You will need to:

  1. build the project using prod setup docker-compose run web npm run build:bundle
  2. open soisy/smoke-test.html page on your browser

The page will call production api using soisytests as a test shop id.

Updating NX

In case you need to update nx to a different major version chances are that you will need to upgrade your workspace as well. NX provides you a migration feature, but migrating the workspace could not be an easy task.

It is best to migrate one major version at a time. Here is the doc about migrations https://nx.dev/cli/migrate

To migrate the workspace you can run:

nx migrate 11.0.0.0 // use desired version here npm i nx migrate --run-migrations=migrations.json for every major version you want to migrate to.