Skip to content

Latest commit

 

History

History
105 lines (80 loc) · 3.17 KB

README.md

File metadata and controls

105 lines (80 loc) · 3.17 KB

Welcome to search-engine 🔍

Version License: MIT

A command line application to search different types of data and return the results in a human-readable format.

Application Instructions

Using the provided data (tickets.json and users.json and organization.json) write a simple command line application to search the data and return the results in a human-readable format.

  • Feel free to use libraries or roll your own code as you see fit. However, please do not use a database or full-text search product as we are interested to see how you write the solution.
  • Where the data exists, values from any related entities should be included in the results,i.e. searching organization by id should return it's tickets and users.
  • The user should be able to search on any field, full value matching is fine (e.g. "mar" won't return "mary").
  • The user should also be able to search for empty values,e.g. where the description is empty. Search can get pretty complicated pretty easily, we just want to see that you can code a basic but efficient search application. Ideally, search response times should not increase linearly as the number of documents grows. You can assume all data can fit into memory on a single machine.

Getting started

Prerequisites

  • node, Run node --version in terminal to verify
  • npm comes with node

Installation

Clone the repository

$ git clone https://github.com/ooanishoo/search-engine
$ cd search-engine

This is the directory/file structure once you clone the repository from the git.

├── README.md
├── data
│   ├── organizations.json
│   ├── tickets.json
│   └── users.json
├── jest
│   └── setup.js
├── jest.config.js
├── package-lock.json
├── package.json
├── src
│   ├── ask
│   │   ├── ask.spec.ts
│   │   └── ask.ts
│   ├── index.ts
│   ├── search
│   │   ├── searchEntity.spec.ts
│   │   └── searchEntity.ts
│   ├── types
│   │   └── index.ts
│   └── utils
│       ├── index.spec.ts
│       └── index.ts
└── tsconfig.json

Install dependencies

npm install

Run application

npm start

Run in dev mode

npm run dev

Run tests

npm test

Packages used:

  • inquirer: A collection of common interactive command line user interfaces.
  • jsonfile: Easily read/write JSON files in Node.js

Author

👤 Anish Maharjan

Show your support

Give a ⭐️ if this project helped you!

This README was generated with ❤️ by readme-md-generator