Human Rights First DocDB

Deployed App: https://a.humanrightsfirstdocdb.dev

Deployed DS API: https://ds.humanrightsfirstdocdb.dev

Contributors

LABS FT 41

Grant Ho

Royce Roberts

Luke Sislowski

Xiao Song

LABS FT 40

Alex Lucchesi

Alyssa Murray

Ben Clowe

Greg Engelmann

Hunter Jordan

Peter Rockwood

Joshua Aurajo

Mark Porath

Youssef Al-Yakoob

Guy Altman

Jake Harris

Jeremy Hebert

Daniel Ferber

Jackson Reber

Madina Izimbetova

Amadou N'Gom

Jacob Smith

Samuel Egbert

Getting Started

• Clone the repo to install it as your own remote.
  • note please be sure to set your remote for this repo to point to your Labs Team Repository.
• run: pip install -r requirements.txt to download all dependencies.

Key Features

• computer vision based document searching
• fast and reliable storage for crucial documents
• accurate and reliable artifact removal
• built in search algorithms for pulling in necessary information

Research

Our research into this project stretches far and wide, covering a multitude of libraries. To better consolidate space, you can find our research here

Tech Stack

• Logic: Python
• API Framework: FastAPI
• Database: MongoDB
• ML Model: Tesseract
• Visualizations: Plotly

Architecture

Installation Instructions

• pip install
  • FastAPI
  • MongoDB
  • Tesseract
  • Plotly

Local Setup (without Docker)

Clone the repo as usual, then cd into the project and create a virtual environment:

python -m venv venv

Activate virtual environment:

source venv/bin/activate

Install dependencies:

pip install -r requirements.txt

Start local server:

uvicorn app.api:API --reload

Local Setup (with Docker)

Clone the repo as usual, then cd into the project, build the Docker image then run it.

docker build . -t docdb
docker run -it -p 5000:5000 docdb uvicorn app.api:API --host=0.0.0.0 --port=5000

AWS Elastic Beanstalk Deployment

eb init
eb create
eb deploy

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

• Update the README.md with details of changes to the interface.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.