diff --git a/README.md b/README.md index 5fe18098..dcdba423 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,10 @@ Your [opinions and feedback](https://binarytree.dev/feedback) about our service | CodeQL | [![CodeQL](https://github.com/lifeparticle/binarytree/actions/workflows/codeql.yml/badge.svg)](https://github.com/lifeparticle/binarytree/actions/workflows/codeql.yml) | | Sonarcloud | [![Build](https://github.com/lifeparticle/binarytree/actions/workflows/sonarcloud.yml/badge.svg)](https://github.com/lifeparticle/binarytree/actions/workflows/sonarcloud.yml) | +# Contributing + +If you'd like to contribute to the project, please check the [How to contribute](CONTRIBUTING.md) file for guidelines and instructions. + ## Licenses Code: The code in this project is licensed under the Apache-2.0 license. See the [LICENSE](LICENSE) file for details. diff --git a/ui/README.md b/ui/README.md index ab030f29..8f6a5d91 100644 --- a/ui/README.md +++ b/ui/README.md @@ -1,23 +1,40 @@ -# Run locally +# Project Setup + +Before running the project, make sure you have the following dependencies installed: + +- Node.js (v18.16.1) +- Yarn (v3.6.1) + +Check your Node.js and Yarn versions to ensure they meet the project's requirements. Open your terminal and run: ```shell node -v # 18.16.1 + yarn -v # 3.6.1 ``` +## Installation + +Install project dependencies using Yarn with the --immutable flag to ensure consistent package versions: + ```shell yarn install --immutable -yarn dev ``` -## Run Test locally +# Running the Project + +To run the project locally, execute the following command: ```shell -yarn test +yarn dev ``` -# Contributing +# Running Tests + +You can also run tests to ensure the project's functionality: -[How to contribute](CONTRIBUTING.md) +```shell +yarn test +``` diff --git a/ui/index.html b/ui/index.html index da4c9cc6..96f7e609 100644 --- a/ui/index.html +++ b/ui/index.html @@ -46,6 +46,9 @@ + + +
diff --git a/ui/src/assets/Footer/bt_dark.png b/ui/src/assets/Footer/bt_dark.png deleted file mode 100644 index a33d45c4..00000000 Binary files a/ui/src/assets/Footer/bt_dark.png and /dev/null differ diff --git a/ui/src/assets/Footer/bt_dark.webp b/ui/src/assets/Footer/bt_dark.webp new file mode 100644 index 00000000..349d7c4f Binary files /dev/null and b/ui/src/assets/Footer/bt_dark.webp differ diff --git a/ui/src/assets/Footer/bt_light.png b/ui/src/assets/Footer/bt_light.png deleted file mode 100644 index f3b87a2a..00000000 Binary files a/ui/src/assets/Footer/bt_light.png and /dev/null differ diff --git a/ui/src/assets/Footer/bt_light.webp b/ui/src/assets/Footer/bt_light.webp new file mode 100644 index 00000000..fbff2251 Binary files /dev/null and b/ui/src/assets/Footer/bt_light.webp differ diff --git a/ui/src/assets/Home/hero.png b/ui/src/assets/Home/hero.png deleted file mode 100644 index 56667a76..00000000 Binary files a/ui/src/assets/Home/hero.png and /dev/null differ diff --git a/ui/src/assets/Home/hero.webp b/ui/src/assets/Home/hero.webp new file mode 100644 index 00000000..656623d7 Binary files /dev/null and b/ui/src/assets/Home/hero.webp differ diff --git a/ui/src/components/General/ClipboardButton/index.tsx b/ui/src/components/General/ClipboardButton/index.tsx index d598b679..c3abfd52 100644 --- a/ui/src/components/General/ClipboardButton/index.tsx +++ b/ui/src/components/General/ClipboardButton/index.tsx @@ -15,6 +15,7 @@ const ClipboardButton: React.FC = ({ className={style.button} onClick={() => copyToClipboard(text)} icon={copied ? : } + aria-label={`select ${label} `} > {label} diff --git a/ui/src/components/General/HelpIcon/index.tsx b/ui/src/components/General/HelpIcon/index.tsx index 884f0070..66a53ad9 100644 --- a/ui/src/components/General/HelpIcon/index.tsx +++ b/ui/src/components/General/HelpIcon/index.tsx @@ -28,6 +28,7 @@ const HelpIcon: React.FC = ({ helpObject }) => { shape="circle" icon={} onClick={showModal} + aria-label="helpicon" /> = ({ )} onOpenChange={handleRedFlagNotification} > - diff --git a/ui/src/components/Layouts/Footer/index.tsx b/ui/src/components/Layouts/Footer/index.tsx index 854c69ee..d1a559b5 100644 --- a/ui/src/components/Layouts/Footer/index.tsx +++ b/ui/src/components/Layouts/Footer/index.tsx @@ -4,8 +4,8 @@ import Icon from "components/General/Icon"; import { Space, Typography } from "antd"; import { ResponsiveButton } from "components/General/FormComponents"; import { Link } from "react-router-dom"; -import bt_light from "assets/Footer/bt_light.png"; -import bt_dark from "assets/Footer/bt_dark.png"; +import bt_light from "assets/Footer/bt_light.webp"; +import bt_dark from "assets/Footer/bt_dark.webp"; import { openLink } from "utils/helper-functions/string"; import useMode from "hooks/useMode"; @@ -30,6 +30,7 @@ const Footer: React.FC = () => { footer logo @@ -53,11 +54,9 @@ const Footer: React.FC = () => {