Skip to content

Latest commit

 

History

History
89 lines (60 loc) · 3.57 KB

README.md

File metadata and controls

89 lines (60 loc) · 3.57 KB
Raw

Toronto Waste Lookup

It is the project for Shopify Web Engineering Challenge. It is a web app to search for waste items using the Toronto Waste Wizard database.

Instructions

The following required functionality is completed:

  • Reproduce the design as provided in the screenshot, which displays example search results.
  • The data must be taken from the Waste Wizard Lookup data (JSON).
  • Typing in the search field should NOT perform an API call.
  • A search must be performed when hitting enter or clicking the search button.
  • When the search input field is cleared, the list of results should also be cleared.
  • Performing a search should render a list of potential matching items based on keywords. Each item should:
    • Render the title and description of the item.
    • Render a grey star button if the item is not already favourited.
    • Render a green star icon if the item is not already favourited.
    • Clicking the star button should add the item to the favourites list.
  • When the number of favourites is more than one, the app should render a list of items. Each saved item should:
    • Render the title and description of the item.
    • Render a green star button if the item has been favourited.
    • Clicking the green star button should remove the item from the saved list.

Video Walkthrough

Video Walkthrough

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them

node >=8.0.0

Installation

Use the package manager pip to install foobar.

git clone https://github.com/ASHISH932/Shopify-Web-Engineering-Challenge.git
cd Shopify-Web-Engineering-Challenge
npm install

Test

npm run test

Usage

npm start

Architecture

App Architecture

Test Cases

The 29 test case of this project is written in jest and enzyme. Enzyme is used for snapshot testing and UI simulation testing.

The test cases are in the same folder structure as the app, so the test case for reducer can be found on reducer folder in test folder.

In-Memory Cache

As per the requirement frequently searched keywords are cached on the server. This is implemented by an in-memory cache.

Implementation

Each keyword occurence is counted in an in memory cache, when it is more than a threshold amount(5 for now) it is been saved in cache for 6 hours.

After the completion of 6 hours, the cache is removed from memory and keyword occurence is reduced by the threshold amount, so that it can be removed from frequently used if it is not accessed now frequently

Built With

  • React - The Frontend Web Framework Used
  • Redux - A predictable state container for JavaScript apps
  • Redux-Saga - Middleware for Redux
  • Jest - Javascript unit testing tool
  • Enzyme - Component testing tool (Snapshot testing)
  • Npm - Dependency Management
  • Express - The Server Framework Used