Skip to content

louremipsum/Virgil

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Virgil

A minimal search engine implementation using ReactJS, Scappy and other technologies

Inspiration

We have named it Virgil as taken inspiration from Virgil who is a well-known and respected figure in literature and specifically from Dante's Divine Comedy. In Dante's Divine Comedy, Virgil serves as Dante's guide through the depths of Hell and Purgatory. He is a symbol of reason and wisdom, helping Dante navigate the complex moral and theological landscape of the afterlife. Throughout their journey, Virgil provides Dante with guidance, encouragement, and insight, ultimately leading him towards salvation in Paradise.

While we don't take responsibility that our search engine will give you enlightenment(haha) but it sure will guide you to great results!

Demo

VirgilDemo

🙋🏻‍♂️ Contribution

Prerequisites:

Architecture

Group 16 (1)

For contribution, You would have to first Fork this repo and then clone it. You can check it here on how you can contribute to a project here Contribution guide. Fork the project, Clone it in your system, install dependencies and make a new branch where you will make the necessary changes/contribution, then push that branch etc. Make sure you follow the proper guide for contributing to making a visible footprint of your impact on the project. To learn Github skills, visit here

The Official Maintainers of this repo will be

Right now, this repository is not open for contribution and will be maintained by the official maintainers only.

Setup

Backend

  • Setup MongoDB Atlas and create a M0 Cluster(Collection of DBs).
  • Create a database in that Cluster for scraped Documents.
  • change the name of set.env -> .env and replace the placeholder values with proper values.
  • type pip install -r requirements.txt in base directory of \Backend folder