From a13b4220d3be9b875a3261c92990b814c5e958f0 Mon Sep 17 00:00:00 2001 From: Krsiak Daniel Date: Thu, 7 Mar 2024 23:10:24 +0100 Subject: [PATCH] Update README.md --- README.md | 45 ++++++++++++++++++++++----------------------- 1 file changed, 22 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index f66f8d3f..9f820eb1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # React Developer - Portfolio Website | krsiak.cz -React Developer portfolio website ๐Ÿ‘จโ€๐Ÿ’ป +[![Jest](https://github.com/krsiakdaniel/portfolio-website-krsiak-cz/actions/workflows/jest.yml/badge.svg)](https://github.com/krsiakdaniel/portfolio-website-krsiak-cz/actions/workflows/jest.yml) [![Playwright Tests](https://github.com/krsiakdaniel/portfolio-website-krsiak-cz/actions/workflows/playwright.yml/badge.svg)](https://github.com/krsiakdaniel/portfolio-website-krsiak-cz/actions/workflows/playwright.yml) [![Build Status](https://badges.netlify.com/api/portfolio-website-krsiak-cz.svg?branch=master)](https://app.netlify.com/sites/portfolio-website-krsiak-cz/deploys) -[![Jest](https://github.com/krsiakdaniel/portfolio-website-krsiak-cz/actions/workflows/jest.yml/badge.svg)](https://github.com/krsiakdaniel/portfolio-website-krsiak-cz/actions/workflows/jest.yml) [![Build Status](https://badges.netlify.com/api/portfolio-website-krsiak-cz.svg?branch=master)](https://app.netlify.com/sites/portfolio-website-krsiak-cz/deploys) +React Developer portfolio website ๐Ÿ‘จโ€๐Ÿ’ป ## โšก Project Website @@ -40,14 +40,13 @@ The website contains the following sections and pages. - ๐Ÿ‘‰ about - ๐Ÿ‘‰ work projects - ๐Ÿ‘‰ personal projects -- ๐Ÿ‘‰ contact **Project pages:** - ๐Ÿ‘‰ page for each project - ๐Ÿ‘‰ project image gallery -## ๐Ÿ’ป Scripts +## ๐Ÿ’ป Commands Install dependencies. @@ -79,16 +78,12 @@ Format the code via Prettier. npm run prettier:fix ``` -## ๐Ÿ› Testing - -This app uses **Jest** for unit testing and **Playwright** for E2E testing. - -### JEST ๐Ÿƒ +## ๐Ÿ› Testing - ๐Ÿƒ JEST Jest is JavaScript Testing Framework. - Test are located folder in `__tests__/jest` -- If file name is `getSkillBadgeColor.ts`, then test name is `getSkillBadgeColor.test.ts`. +- Naming is `file.test.ts` Runs the unit tests. @@ -96,7 +91,7 @@ Runs the unit tests. npm run test ``` -#### Test coverage - Jest +### Test coverage Jest will generate a code coverage report. @@ -107,11 +102,12 @@ Jest will generate a code coverage report. npm run test:coverage ``` -### Playwright ๐ŸŽญ +## ๐Ÿ› Testing - ๐ŸŽญ Playwright Playwright is library for browser automation E2E testing. - Test are located folder in `__tests__/playwright` +- Naming is `file.spec.ts` Runs the E2E tests. @@ -125,7 +121,7 @@ Runs the E2E tests using alias for `npx playwright test` npm run test:e2e ``` -#### Test coverage - Playwright +### Test coverage Playwright will generate a code coverage report. @@ -135,7 +131,7 @@ Playwright will generate a code coverage report. npx playwright show-report ``` -#### Other Playwright commands +### Other Playwright commands Starts the interactive UI mode. @@ -167,15 +163,13 @@ Auto generate tests with Codegen. npx playwright codegen ``` -## ๐Ÿš€ Deployment CI / CD - -This app uses GitHub Actions for CI and Netlify for CD. - -### CI - Continuous Integration ยท [![Jest](https://github.com/krsiakdaniel/portfolio-website-krsiak-cz/actions/workflows/jest.yml/badge.svg)](https://github.com/krsiakdaniel/portfolio-website-krsiak-cz/actions/workflows/jest.yml) +## ๐Ÿš€โ™ป๏ธ CI - Continuous Integration This app uses GitHub Actions for CI. -#### GitHub Actions - Workflow "Jest" +### GitHub Actions - Workflow "Jest" + +[![Jest](https://github.com/krsiakdaniel/portfolio-website-krsiak-cz/actions/workflows/jest.yml/badge.svg)](https://github.com/krsiakdaniel/portfolio-website-krsiak-cz/actions/workflows/jest.yml) - Workflow file: [jest.yml](.github/workflows/jest.yml) - View the results on GitHub: [actions/workflows/playwright.yml](https://github.com/krsiakdaniel/portfolio-website-krsiak-cz/actions/workflows/playwright.yml) @@ -209,7 +203,9 @@ The `build` job follows these steps: -#### GitHub Actions - Workflow "Playwright" +### GitHub Actions - Workflow "Playwright" + +[![Playwright Tests](https://github.com/krsiakdaniel/portfolio-website-krsiak-cz/actions/workflows/playwright.yml/badge.svg)](https://github.com/krsiakdaniel/portfolio-website-krsiak-cz/actions/workflows/playwright.yml) - Workflow files in project root: [playwright.yml](.github/workflows/playwright.yml) - View the results on GitHub: [actions/workflows/playwright.yml](https://github.com/krsiakdaniel/portfolio-website-krsiak-cz/actions/workflows/playwright.yml) @@ -242,11 +238,14 @@ The `test` job follows these steps: -### CD - Continuous Deployment ยท [![Build Status](https://badges.netlify.com/api/portfolio-website-krsiak-cz.svg?branch=master)](https://app.netlify.com/sites/portfolio-website-krsiak-cz/deploys) + +## ๐Ÿš€ โœ… CD - Continuous Deployment This app is deployed on Netlify. -#### Netlify +### Netlify + +[![Build Status](https://badges.netlify.com/api/portfolio-website-krsiak-cz.svg?branch=master)](https://app.netlify.com/sites/portfolio-website-krsiak-cz/deploys) Build starts when a new commit is pushed to the `master` branch.