Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 2.15 KB

README.md

File metadata and controls

81 lines (54 loc) · 2.15 KB

Walcron, a personal website

A personal website for self-learning interest.

Build Status Code Coverage

How to Use

In your terminal, run the following command:

For local execution:

npm run dev

For test with watch

npm run test

For test coverage

npm run test:ci

For linting and prettifier check

npm run lint

For backstop - view, approve website design. Note: that browser executes differently in OS, especially font's. In this case use the approved generated directly from the OS/Docker container.

npm run backstop:test  //To test
npm run backstop:approve // Approve the new website ok

Run Github workflows

Project is tied closely with github.

To create a new change, do a pull request. (Master is still not locked)

  1. Create a branch for changes in lowercase with no space.
  2. Commit the changes in the branch.
  3. Push.
  4. In github, create a pull request.
  5. Check that the workflow is executed without error.
  6. Merge the commit.

In case there is a need to generate a new backstopJS approved page.

  1. In github, go to Actions tab.
  2. Select 'Create approved snapshot'.
  3. Click on 'Run workflow'
  4. Enter the vercel/public website to generate an approved website. All foreslash needs to be escaped with a single-backslash, e.g. https://www.walcron.com to https:\/\/www.walcron.com

Updating backstopJS snapshot.

--By pull request

  1. Download the artifacts generated in "Summary" of the latest build. Replace generated snapshot in backstop_data/bitmaps_test//!failed.png
  2. replace into bitmaps_reference.

--By action

  1. Download the artifacts generated in latest requested workflow. Replace generated snapshot in backstop_data/bitmaps_reference/*
  2. replace into bitmaps_reference.xw