tsche043/hw1_api repository overview

#Simple search engine API Simple search engine API. Returns "results" for 3 keywords. ##Introduction Tal Cual is a Spanish/Portuguese language search engine, intended for use in the South American (Venezuelan), and European markets. My "real" prototype version of this employs a web crawler, and a multithreaded downloader. It also returns an index of web pages (mostly in Spanish). For the purposes of this assignment, I removed and modified a good deal of the backend code, so that it only returns 3 very primative html pages. ##Goal The goal of this assignment was to produce and document a simple API, and then push its docker image to Docker Hub. ##Tools Used The tools used for this assignment are,

1. Docker
2. Node.js/Express.js
3. VisualStudioCode (Any IDE or even a texteditor could also work)
4. A computer with internet connectivity and a web browser.
   * If possible do the build on a mac or linux machine, as I did not
   get a chance to test it on a windows machine. ##How to use?
5. Make sure your computer has the latest version of Docker installed. If your device does not have Docker you can download it from the below link.
   https://www.docker.com/products/docker-desktop⁠
   
   2. Once you know docker is installed open terminal and run the following command
   
   docker pull tsche043/hw1_api
   
   
6. Now run
   
   docker run -p 127.0.0.1:9007:9007 -it tsche043/hw1_api
   
   

This will start the javascript server. To test the search engine, open a web browser and navigate to localhost:9007. This will open the tal cual search engine front end. To interact with the front end simply enter search queries where prompted. This sample server can only process three inputs "dogs", "Soviet futuristic apartments", and "Rockets". The server will return one of three .html pages, based on the search query entered.