Code Monkey home page Code Monkey logo

human-rights-first-docdb-fe's Introduction

Humans Rights First Document Database

MIT React

View the project. (Login required during development.)


About Human Rights First

Human Rights First is an independent advocacy and action organization that challenges America to live up to its ideals. They believe American leadership is essential in the global struggle for human rights, so they press the U.S. government and private companies to respect human rights and the rule of law. When they fail, they step in to demand reform, accountability and justice. Around the world, they work where they can best harness American influence to secure core freedoms.


Our Product

HRF and the Pat Finucane Centre need a way to let researchers view and search historical documents related to The Troubles to identify potential human rights abuses and empower victims' families with evidence to bring legal cases.


Features

  • Interprets document files using Optical Character Recognition (OCR)
  • Clean, simple interface to search & view documents
  • Bookmark documents & add tags
  • Scrape documents for fields of interest



Tech Stack

Frontend Backend Data Science
Javascript Node.js Python
React Express MongoDB
Redux Okta Auth Docker
Axios PostgreSQL FastAPI
HTML5 Tesseract
CSS3 Plotly

APIs

To learn more about this project's APIs, please view the backend readme.

To learn more about the data science behind the project, please visit our DS team's readme.



Interested in 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.


Installation

  • Fork and clone the repo to install it as your own remote.
  • run: npm install to download all dependencies.
  • Create your .env file and update it with the environment variables you will have received from this product's Release Manager.
  • run: npm start to start your local development server.

When using Okta for authentication, the app will need to run locally on port 3000.


Contributors

LABS FT 41

Klove Adams

Stu Darsley

Michael Greenwald

Sarah Herren

Allison Homem

Amy Lam

Jennifer Misch

Thomas Moore

Mason Mostella

Michael Steiner

Robert Taveras

Jonah Tillman


LABS FT 40

Andrew Busby

Luiza Coelho

Nora Corser

Bailey Evanger

Ryan Ishimaru

Philip Lee

Jesse Leegwater

Cara Locke

Juliane Nguyen

Jack Orth

Rimsha Saleem

Dharmik Savaliya

Andrew Schaer

Romy Shockey

Jacob Shomali

Brandon Verfurth

Tawnya Wessar


Release Manager

Paul St.Germain



Scripts

* build - creates a build of the application
* start - starts the production server after a build is created
* test - runs tests in **tests** directory
* lint - use eslint
* format - use prettier

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, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number, if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

human-rights-first-docdb-fe's People

Contributors

allisonhomem avatar andrewsbusby avatar andrewschaer avatar bevanger avatar bobby-tav avatar caralocke avatar collerhatguy avatar fervelgo avatar heyanwar avatar jleegwater avatar jmisch44 avatar klove-a avatar lncpadawan avatar mmostella avatar nora-exe avatar paulstgermain avatar rimshasaleem avatar rkshockey avatar ryan-hamblin avatar sarahdherren avatar someilam avatar steinmikey avatar stu-wd avatar tdubs42 avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.