Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chesleybrown/micro-search-engine-challenge
A micro search engine concept
https://github.com/chesleybrown/micro-search-engine-challenge
Last synced: 15 days ago
JSON representation
A micro search engine concept
- Host: GitHub
- URL: https://github.com/chesleybrown/micro-search-engine-challenge
- Owner: chesleybrown
- Created: 2014-11-01T14:56:27.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2014-11-04T20:21:30.000Z (about 10 years ago)
- Last Synced: 2023-03-11T18:47:56.453Z (over 1 year ago)
- Language: JavaScript
- Size: 695 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Micro Search Engine Challenge
======
[](https://travis-ci.org/chesleybrown/micro-search-engine-challenge)
This implements a simple search API which accepts a word list and enables the searching of words in that list that start with a specified string.
# Setup
Just need to install the node modules:
```
npm install
```
# Tests
To execute all the tests, just run:
```
npm test
```
# Running
Server runs on port `8000` by default, but will use the port set
on the environment variable `PORT` if set.
To start the server, just run:
```
npm start
```
# API
## Dictionary
`POST` `/dictionary/`
The dictionary of words to search through.
**Input:** JSON containing an array of words, e.g. `["foo", "bar", ...,]`
**Output:** Returns an HTTP `204` status for valid data.
## Search
`GET` `/search/:string`
All words that start with `:string` - e.g. `/search/foo` will return all
words in the supplied dictionary starting with `foo`, including `foo`
itself.
**Input:** the `string`, specified in the URL
**Output:** A JSON array of words in the dictionary which start with the
specified string, all in lower case. Returns an HTTP `200` status
for valid data, even if no words are found (returns an empty array in that case)