Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.41 KB

README.md

File metadata and controls

37 lines (25 loc) · 1.41 KB

Eureka Search

This is a Makers Academy final project. We were tasked with working on a project of our choice in languages, testing frameworks and technologies of our choice over the course of 11 days.

We chose to build a search engine, writing the query engine in Node.js and the crawler in Python.

Central throughout the project were TDD/BDD, XP values and agile practices. We used a Kanban workflow to manage the project's progression.

Epic User Story

As a user of the web,
So that I can find interesting webpages,
I want to be able to input multiple words and see all related webpages.

Usage instructions

  • Follow the instructions on Eureka Crawler to run a crawl
  • git clone this repo
  • npm install to install dependencies listed in package.json
  • npm test to run all tests
  • Run nodemon to start up Eureka Search Engine locally
  • Visit localhost:3000 in your favourite browser and search the websites from your crawl

Technologies

  • JavaScript
  • Node.js
  • Express
  • Mocha & Chai (testing framework/assertion library)
  • PostgreSQL