Skip to content

Commit

Permalink
Merge pull request #21 from yun-cheng/docs/readme-features
Browse files Browse the repository at this point in the history
docs: add readme features
  • Loading branch information
yun-cheng authored Mar 28, 2024
2 parents 00b7fa4 + 28dda31 commit d9d052a
Show file tree
Hide file tree
Showing 9 changed files with 34 additions and 10 deletions.
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Visit live site: <https://aha-frontend-assessment.web.app/>

This project follows [these instructions](https://rootdomain.notion.site/Candidate-Exam-Front-End-Engineer-ac3dd8a3474542899d49efb894672246) and is built according to [this Figma design](<https://www.figma.com/file/Vuu52JkGcLb3m3uVvF3DA3/Aha-Front-end-Assessment-(clone)?type=design&node-id=0%3A1&mode=design&t=kKtr558af85zwltM-1>) to complete the assessment tasks.

For a detailed side-by-side comparison of the design and implementation, [click here](<https://www.figma.com/file/Vuu52JkGcLb3m3uVvF3DA3/Aha-Front-end-Assessment-(clone)?type=design&node-id=25101%3A309&mode=design&t=mfH6vNOlPhpAZRO1-1>).
For a detailed side-by-side comparison of the design and implementation, [click here](<https://www.figma.com/file/Vuu52JkGcLb3m3uVvF3DA3/Aha-Front-end-Assessment-(clone)?type=design&node-id=25101%3A309&mode=design&t=mfH6vNOlPhpAZRO1-1>). The differences between the design and implementation are explained in the comments.

## Tech Stack

Expand All @@ -18,9 +18,41 @@ For a detailed side-by-side comparison of the design and implementation, [click
- Utilize [TanStack Query](https://tanstack.com/query) for efficient data fetching, caching, and synchronization.
- Use [React Router](https://reactrouter.com/) for code-splitting and lazy-loaded routes.
- Style using the atomic approach with [Tailwind CSS](https://tailwindcss.com/), alongside [clsx](https://github.com/lukeed/clsx) and [tailwind-merge](https://github.com/dcastil/tailwind-merge), to prevent style conflicts and enhance readability.
- Leverate [Material UI](https://mui.com/material-ui/) for ready-to-use components.
- Leverage [Material UI](https://mui.com/material-ui/) for ready-to-use components.
- Implement grid layout using CSS Grid.
- Automate deployment to [Firebase Hosting](https://firebase.google.com/docs/hosting) through [GitHub Actions](https://docs.github.com/en/actions) for continuous integration.
- Adopt an atomic approach to state management with [Jotai](https://jotai.org/).
- Generate realistic images and avatars with [Faker](https://fakerjs.dev/).
- Use [react-intersection-observer](https://github.com/thebuilder/react-intersection-observer) to achieve infinite loading and lazy load images.
- Implement self-hosted fonts using [Fontsource](https://fontsource.org/).

## Features

### Skeleton

![tags_skeleton](screenshots/tags_skeleton.gif)
![results_skeleton](screenshots/results_skeleton.gif)

### Infinite scrolling

![infinite_scrolling](screenshots/infinite_scrolling.gif)

### Lazy load images

![lazy_load_images](screenshots/lazy_load_images.gif)

### Responsive Web Design (RWD) across all pages

![home_rwd](screenshots/home_rwd.gif)
![results_rwd](screenshots/results_rwd.gif)
![tags_rwd](screenshots/tags_rwd.gif)

### Other features

- Code-splitting and lazy-loaded routes
- Dynamic document title

## TODO

- Error handling
- Testing
Binary file added screenshots/home_rwd.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/infinite_scrolling.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/lazy_load_images.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/results_rwd.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/results_skeleton.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/tags_rwd.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/tags_skeleton.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 0 additions & 8 deletions src/components/common/Slider/Slider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,3 @@ export default function Slider({
/>
)
}

// font-weight: 500;
// font-size: 16px;
// letter-spacing: 0.15px;

// font-weight: 400;
// font-size: 14px;
// letter-spacing: 0.25px;

0 comments on commit d9d052a

Please sign in to comment.