Gremlin Frontend Take Home

Build NPM package search tool

What we are looking for
Example API request
Extra Credit

The task is to build a search form for npm packages and display a list from the API call payload.

The presented UI should function in a similar way to npmjs.com search results. Your design does not have to look exactly like the linked page. We are concerned more about the functionality than styling. With that being said, we are looking for consistency and the use of best practices in whichever way you choose to style the page (UI library, css-in-js, sass, etc.).

Please fork this repo and then provide us with a link to your forked copy, a codesandbox, etc.

The GET request should be made to the following endpoint: https://api.npms.io/v2/search/suggestions?q=${queryString}

You may use any pattern or library that you find suitable to accomplish this task.

What we are looking for

Does it work?
- User can search for a package
- Returned list of packages are displayed and linked to their page on npm.
- Each row should contain at least the package's name and description. Other data is considered bonus and should be added if time allows.
Does the implementation handle loading and error states?
Styling should be consistent and make use of best practices.
Proper use of React APIs.
Clean, well-commented code. We prefer clarity over cleverness.

React

You may use whatever patterns and state management you prefer while working on this. The choice of libraries and state management patterns is not as important as a functioning project.

Extra Credit

Include a test suite
Utilization of latest React APIs
Implement functionality to fail the API requests on purpose to test error states
- Could be a fixed position checkbox or overlay with options
Dynamic theming
Mobile breakpoints and responsive design

Expectations

We think the main task should take about 2 hours
Please keep a tidy commit history and separate out the commits for the main task and extra credit task

Example API request

The request

https://api.npms.io/v2/search/suggestions?q=react-window

Returns

[
  {
    "package": {
      "name": "react-window",
      "scope": "unscoped",
      "version": "1.8.7",
      "description": "React components for efficiently rendering large, scrollable lists and tabular data",
      "keywords": [
        "react",
        "reactjs",
        "virtual",
        "window",
        "windowed",
        "list",
        "scrolling",
        "infinite",
        "virtualized",
        "table",
        "grid",
        "spreadsheet"
      ],
      "date": "2022-04-23T14:22:43.250Z",
      "links": {
        "npm": "https://www.npmjs.com/package/react-window",
        "homepage": "http://react-window.now.sh/",
        "repository": "https://github.com/bvaughn/react-window",
        "bugs": "https://github.com/bvaughn/react-window/issues"
      },
      "author": {
        "name": "Brian Vaughn",
        "email": "[email protected]",
        "url": "https://github.com/bvaughn/"
      },
      "publisher": {
        "username": "brianvaughn",
        "email": "[email protected]"
      },
      "maintainers": [
        {
          "username": "brianvaughn",
          "email": "[email protected]"
        },
        {
          "username": "mjackson",
          "email": "[email protected]"
        }
      ]
    },
    "score": {
      "final": 0.7191781278776386,
      "detail": {
        "quality": 0.9372693112538775,
        "popularity": 0.6046811468515499,
        "maintenance": 0.646739808866951
      }
    },
    "searchScore": 1022.8565,
    "highlight": "<em>react</em>-<em>window</em>"
  },
  {
    "package": {
      "name": "react-window-infinite-loader",
      "scope": "unscoped",
      "version": "1.0.8",
      "description": "InfiniteLoader component inspired by react-virtualized but for use with react-window",
      "keywords": [
        "react",
        "reactjs",
        "virtual",
        "window",
        "windowed",
        "list",
        "scrolling",
        "infinite",
        "virtualized",
        "table",
        "grid",
        "spreadsheet"
      ],
      "date": "2022-06-08T18:23:24.830Z",
      "links": {
        "npm": "https://www.npmjs.com/package/react-window-infinite-loader",
        "homepage": "https://github.com/bvaughn/react-window-infinite-loader/",
        "repository": "https://github.com/bvaughn/react-window-infinite-loader",
        "bugs": "https://github.com/bvaughn/react-window-infinite-loader/issues"
      },
      "author": {
        "name": "Brian Vaughn",
        "email": "[email protected]",
        "url": "https://github.com/bvaughn/"
      },
      "publisher": {
        "username": "brianvaughn",
        "email": "[email protected]"
      },
      "maintainers": [
        {
          "username": "brianvaughn",
          "email": "[email protected]"
        },
        {
          "username": "andrewbeletskiy",
          "email": "[email protected]"
        }
      ]
    },
    "score": {
      "final": 0.718726945562352,
      "detail": {
        "quality": 0.8464094502755721,
        "popularity": 0.32808736500728325,
        "maintenance": 0.9999243792203749
      }
    },
    "searchScore": 21.057629,
    "highlight": "<em>react</em>-<em>window</em>-infinite-loader"
  }
]

sbodi10 / gremlin-frontend-take-home Goto Github PK