Skip to content

Latest commit

 

History

History
151 lines (102 loc) · 5.44 KB

README.md

File metadata and controls

151 lines (102 loc) · 5.44 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 package analysing, do not check-in as it contains alot of security issues.

npm install @next/bundle-analyzer
# Wrap next.config.js with withBundleAnalyzer({...})
npx next build

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

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

Setting environments

  1. Install Vercel Cli, with npm i -g vercel
  2. Pull all the environment into local with vercel env pull .env.local. This wil create an environment straight for testing. Incase, there are reset of environment to setup in Vercel, refer to .env file.

Run Github workflows

Project is tied closely with github.

To create a new change, do a pull request.

  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 By File'.
  3. Click on 'Run workflow'
  4. Enter the vercel/public website to generate an approved website domain. Without http, e.g. https://www.walcron.com to www.walcron.com
  5. Manually enter a valid branch it can checkout, e.g. develop.

Updating backstopJS snapshot.

--By pull request

  1. Download the artifacts generated in "Summary" of the latest build. Replace generated snapshot in backstopdata/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.

--Auto approval (Recommended)

  1. Get the latest pipeline no from snapshotcheck.sh output from previous failed Validation workflow.
  2. OR view latest running script in github's Actions tab for Validation workflow.
  3. Execute the command below and it will auto-approve and rerun Validation workflow again.
echo ${running no# +1} > backstopjs.approve
git add backstopjs.approve
git push

Note: Add create PAT, personal profile -> Developer Settings -> Fine Grain Token -> Actions(R)/Commit Statues(RW)/Contents(RW)/Metadata(R)

Deployment to Vercel

  1. Project deployment works differently as there is NO hosting page. Means navigating to the page e.g. https://zelda-auth-react-walcoorperation.vercel.app/ will deal with NO Page found.
  2. All hosted microservice must be access via the js script, as in https:///walcron-zelda-auth-react.js
  3. Create a Github PAT (classic), with only read:packages access.
  4. Login locally into github NPM repo with the PAT.

npm login --scope=@yoonghan --auth-type=legacy --registry=https://npm.pkg.github.com/

  1. Copy in ~/.npmrc into vercel's variable NPM_RC. Basically the varible will contain:
//npm.pkg.github.com/:_authToken=...
@yoonghan:registry=https://npm.pkg.github.com/

Deployment for Github PAT permission

  1. For accessing private repo, please allow Profile -> Settings -> Personal Access Token (classic), open read:packages (basically th esame as vercel deployment). For more info refer: https://docs.github.com/en/packages/working-with-a-github-packages-registry. Add as Github secret in Settings->Secrets And variable and add NPM_TOKEN key. NOTE: In merge NODE_AUTH_TOKEN is used instead.
  2. Workflow requires
  3. registry-url in checkout action,
  4. NODE_AUTH_TOKEN env. If the workflow is callable, use "secrets: inherit", else secret cannot be shown. To test print with echo ${#NODE_AUTH_TOKEN} and should return some integer values.

Vercel/NextJS

  1. NextJS on vercel re-uses .next build cache. This sometimes creates an issue, e.g. a page that was once deployed as AMP will forever be recognized as AMP until the cache is cleared.
  2. To build without previous build cache; click redeploy button from Vercel dashboard (a menu from the 3 vertical dots) and uncheck "Build with previous build cache".

NextJS Static Site Generation

NextJS for static generation ouput: "export" in next.config.js, requires all pages to have removed "use server". Generally all pages that requires /api call needs to be removed as well, hence need to figure out how to relink these site directly to walcron.

Rust Webassembly

  1. To regenerate new Wasm from webassembly, run the command below:
  2. The scripts include a custom .gitignore.
npm run rust:generate
npm run rust:test //test rust running on browser