Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update lighthouse report #357

Merged
merged 6 commits into from
Oct 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
29 changes: 23 additions & 6 deletions ui/README.md
Original file line number Diff line number Diff line change
@@ -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
```
3 changes: 3 additions & 0 deletions ui/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@

<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/logo.svg" />

<!-- To establish an early connection to the Google Analytics domain -->
<link rel="preconnect" href="https://www.google-analytics.com" />
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please link the documentation for this

</head>
<body>
<div id="root"></div>
Expand Down
Binary file removed ui/src/assets/Footer/bt_dark.png
Binary file not shown.
Binary file added ui/src/assets/Footer/bt_dark.webp
Binary file not shown.
Binary file removed ui/src/assets/Footer/bt_light.png
Binary file not shown.
Binary file added ui/src/assets/Footer/bt_light.webp
Binary file not shown.
Binary file removed ui/src/assets/Home/hero.png
Binary file not shown.
Binary file added ui/src/assets/Home/hero.webp
Binary file not shown.
1 change: 1 addition & 0 deletions ui/src/components/General/ClipboardButton/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ const ClipboardButton: React.FC<ClipboardButtonProps> = ({
className={style.button}
onClick={() => copyToClipboard(text)}
icon={copied ? <Icon name="Check" /> : <Icon name="Copy" />}
aria-label={`select ${label} `}
>
{label}
</ResponsiveButton>
Expand Down
1 change: 1 addition & 0 deletions ui/src/components/General/HelpIcon/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ const HelpIcon: React.FC<HelpIconProps> = ({ helpObject }) => {
shape="circle"
icon={<Icon name="Info" size={15} />}
onClick={showModal}
aria-label="helpicon"
/>
<Modal
title="Help"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,10 @@ const NotificationList: React.FC<NotificationListProps> = ({
)}
onOpenChange={handleRedFlagNotification}
>
<Button className={style.notification__button}>
<Button
aria-label="notification-icon"
className={style.notification__button}
>
<span
className={
showRedFlag ? style.notification__button__status : ""
Expand Down
2 changes: 1 addition & 1 deletion ui/src/components/Layouts/FloatingHeader/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const FloatingHeader: React.FC<FloatingHeaderProps> = ({ styles }) => {
<div className={style.fh} style={styles}>
<Notification />
<Link to="/feedback">
<Button className={style.fh__button}>
<Button aria-label="feedback-icon" className={style.fh__button}>
<Icon name="Megaphone" size={20} />
</Button>
</Link>
Expand Down
29 changes: 12 additions & 17 deletions ui/src/components/Layouts/Footer/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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";

Expand All @@ -30,6 +30,7 @@ const Footer: React.FC = () => {
<img
src={isDarkMode ? bt_dark : bt_light}
height={100}
alt="footer logo"
/>
</Link>
</Space>
Expand All @@ -53,11 +54,9 @@ const Footer: React.FC = () => {
<ul className={style.footer__list}>
<li>
<a
onClick={() =>
openLink(
"https://github.com/users/lifeparticle/projects/2"
)
}
href="https://github.com/users/lifeparticle/projects/2"
target="_blank"
rel="noopener noreferrer"
>
Roadmap
</a>
Expand All @@ -70,22 +69,18 @@ const Footer: React.FC = () => {
<ul className={style.footer__list}>
<li>
<a
onClick={() =>
openLink(
"https://github.com/lifeparticle/binarytree/blob/main/CODE_OF_CONDUCT.md"
)
}
href="https://github.com/lifeparticle/binarytree/blob/main/CODE_OF_CONDUCT.md"
target="_blank"
rel="noopener noreferrer"
>
Code of Conduct
</a>
</li>
<li>
<a
onClick={() =>
openLink(
"https://github.com/lifeparticle/binarytree#status"
)
}
href="https://github.com/lifeparticle/binarytree#status"
target="_blank"
rel="noopener noreferrer"
>
Status
</a>
Expand Down
1 change: 1 addition & 0 deletions ui/src/components/Layouts/Header/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ const Header: React.FC = () => {
src={isDarkMode ? logo_dark : logo_light}
height={60}
width={60}
alt="Logo"
/>
</Link>
</Space>
Expand Down
2 changes: 2 additions & 0 deletions ui/src/components/Layouts/Sidebar/Footer/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ const Footer: React.FC<FooterProps> = ({
</a>

<Switch
aria-label="toggle theme"
checkedChildren={
<div className={style.footer__moon}>
<Icon size={16} color={colorBgContainer} name="Moon" />
Expand All @@ -56,6 +57,7 @@ const Footer: React.FC<FooterProps> = ({
onClick={handleMenuCollapse}
type="text"
className={style.footer__menuCollapse}
aria-label="toggle-theme"
>
{collapsed ? (
<Icon name="ChevronsRight" color={colorText} />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const ColorFormatTags = ({
color={currentFormat === option.value ? "success" : "default"}
key={option.value}
className={style.cf}
aria-label={`select ${option.label}`}
>
{option.label}
</Tag>
Expand Down
1 change: 1 addition & 0 deletions ui/src/pages/Colors/ColorPicker/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ const ColorPicker: React.FC = () => {
setColorPickerRan(false);
}}
size="xl"
aria-label="select a color"
/>

<ResponsiveButton
Expand Down
4 changes: 3 additions & 1 deletion ui/src/pages/Home/components/Hero.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import React from "react";
import style from "pages/Home/Home.module.scss";
import { Typography, Image } from "antd";
import hero from "assets/Home/hero.png";
import hero from "assets/Home/hero.webp";
import { FEATURE_DATA } from "data/featureData";

const { Title } = Typography;
Expand Down Expand Up @@ -33,6 +33,8 @@ const Hero: React.FC = () => {
src={hero}
alt="BinaryTree: Developer Productivity Tools"
preview={false}
width={"100%"}
height={"100%"}
/>
</div>
</section>
Expand Down