Mirrulations Search

Contributors:

• Thomas Abato
• Kyle Adams
• Marie Addo
• Jake Clause
• Ben Coleman
• Colin Conway
• Dylan Fodor
• Nate Garay
• Jeremy Goll
• Maxwell Houck
• Anna Huang
• Vito Leone
• Devin McCormack
• David Olsakowski
• Carlton Reyes
• Shawn Ryer
• Jacob Smith
• Luke Suppa

Project Description:

Characteristics of the Repo:

• Hosted in our Github organization
  • All students have a fork
• Setup process is documented in README.md
• CI runs on PR creation/update
  • pytest and jest
  • linting (both Python and JavaScript)
• CD runs on PR merge
  • deploy script runs on AWS instance
• setup.cfg contains the python libraries needed
• database access is encapsulated (pushed to the periphery)
• src and tests folders, module for app

Application:

We have established a system in which a front-end React-based search utility utilizes a Flask API and gives back results from a Mongo database.

• Mongo DB as the backend
• Flask server
• Gunicorn
• NGINX
• Dockerized via Docker-Compose
• React frontend for querying API results
• AWS Lambda
• AWS Secrets Manager
• AWS S3
• Amazon Opensearch

Makefile:

Use the command make to run the Makefile. The Makefile will call pytest, pylint, jest, and eslint to test and lint the system.

Launching the System Locally:

Launching the system involves a number of steps to be followed before the utility is usable.

To do this, visit docs/development.md for a detailed walkthrough.