Skip to content

Instantly share code, notes, and snippets.

@chermehdi

chermehdi/search_engine.md

Created April 24, 2020 14:29
Show Gist options
  • Save chermehdi/0d2bdd0704b3715e12fdbd7aa522e8fb to your computer and use it in GitHub Desktop.
Save chermehdi/0d2bdd0704b3715e12fdbd7aa522e8fb to your computer and use it in GitHub Desktop.
Download ZIP
Raw
search_engine.md

Mini search engine

Functional requirements

  • Should produce a binary (all dependencies included).

  • Should be able to process 2 command line arguments:

    • URL(required): the starting url of a webpage where the crawler is going to start from.
    • depth(optional, default=20): The depth where the crawler should stop

  • Starting the app should start the crawling process, and also should start an http server exposing a REST api to query the results.

  • When asking for a query which can be any word / phrase, the returned values should contain the location of the search term, and the link to access it.

None-functional requirements

  • Unit testing all aspects of the project is a must.
  • Good documentation should be provided.
  • Performance and good design.
  • All should be hosted in a github repository with contribution instructions, installation instructions and a LISENCE file.

Technologies and programming languages

  • None specified.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment