Overview

This is a candidate task for Quandoo.

It is a simple React app including:

1. Search with autocomplete for pre-defined GitHub users
2. After typing or selecting GitHub user search request will be sent to GitHub API to fetch user info
3. Results page displays user info (such as name, login, location, bio)
4. Unit tests with Jest including snapshot tests
5. Webpack, ESlint, Babel config from scratch
6. Yarn to lock the dependencies

Home Autocomplete Results

Usage

To run the project locally clone the repo:

$ git clone https://github.com/alexandr-g/quandoo.git

Install project dependencies:

$ yarn

or

$ npm i

Build a valid js bundle:

$ yarn build

To start the project in development mode:

$ yarn dev

Open http://localhost:8080 in your browser that will serve webpack output with running app

Testing

Run the tests using Jest including snapshot tests:

$ npm t or yarn test

Linting

Run the linter by executing:

$ yarn lint

Project Structure

├── __tests__                       - Jest unit tests
├── src                             - All the source code
│   ├── components                  - React UI components
│   ├── utils                       - API helpers
│   └── index.js                    - JS entry point
├── .babelrc                        - Babel config to transpile ES6
├── .eslintrc.json                  - ESLint config
├── .gitignore                      - Ignore files for source control (node_modules, test coverage)
├── index.html                      - HTML file where React app lives
├── package.json                    - List of dependencies, npm scripts, author etc.
├── README.md                       - Project Overview and instruction how to run, test, lint
├── webpack.config.js               - Webpack build steps/config
├── yarn.lock                       - Locked project dependencies