Skip to content

BloomTech-Labs/Labs25-Human_Rights_First-TeamA-BE

Repository files navigation

1️⃣ Human Rights First - Police Incident Report

1️⃣ You can find the deployed project at Police Use of Force Tracker.

4️⃣ Contributors

Cole Wilkison Gordon Caister Andrew Hoffman Nathan Howland Phil Fives


MIT React code style: prettier

Project Overview

1️⃣ Trello Board

1️⃣ Product Canvas

Single page application that maps police brutality based on scraping data from Twitter and Reddit. It includes a timeline view, visual map and feed page. Intended for journalists, activists and lawyers.

4️⃣ Key Features

  • Interactive Map
  • Timeline
  • Feed page
  • Search Function

1️⃣ Tech Stack

Front end built using:

React

  • React is highly customizable with 3rd party wrappers and libraries

  • React handles single page applications extremely well and can be expanded to multipage applications easily

  • React puts most of the rendering on the client, thus reducing the amount of server power required

  • Ant Design

  • React-Google-Map

  • craco-less

Front end deployed to AWS Amplify

Node

  • It is a built in requirement from Engineering Standards

  • It has better efficiency and developer productivity

  • It is easily scalable

  • Express

  • Axios

  • Knex

  • Postgres

  • CORS

APIs

2️⃣ Okta Authentication

The Okta Authentication API provides operations to authenticate users, perform multifactor enrollment and verification, recover forgotten passwords, and unlock accounts. Primary authentication allows you to verify username and password credentials for a user.

3️⃣ Google Maps API

Allows building of customized, agile experiences that bring the real world to our users with static and dynamic maps, Street View imagery, and 360° views.

3️⃣ Back-End API

Allows for access of locations of police incidents and details.

3️⃣ Data Science API

Data Science scrapes data from Twitter and Reddit which compiles and cleans that information for the Web Developers.

3️⃣ Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

*  PORT - What port the backend is on
*  DS_API_URL - Data Science API
*  DS_API_TOKEN - Secret Token for DS API
*  DATABASE_URL - Postgres URL for our database, includes username, password, port and database name
*  OKTA_URL_ISSUER - URL connecting authentification to Okta
*  OKTA_CLIENT_ID - Client specific id for web dev
*  REACT_APP_CLIENT_ID - Okta client specific id for front end
*  REACT_APP_OKTA_ISSUER_URI - Okta URL connecting with authentification for front end
*  REACT_APP_API_URI - API URL for back end API
*  REACT_APP_GOOGLE_MAPS_API_KEY - Google Maps API key

5️⃣ Content Licenses

Image Filename Source / Creator License
doodles.png Nicole Bennett Creative Commons
rings.svg Sam Herbert MIT

4️⃣ Testing

  • SuperTest
  • Jest
  • Cypress

4️⃣ Installation Instructions

  • Navigate to the root directory with this README in it.
  • Using NPM: npm install
  • then type 'npm start'

Other Scripts

* npm start
  - starts the production server after a build is created
* start: "craco --max_old_space_size=4096 start"
  - Increases JavaScript heap size
* test:
  - Craco test --env=jest-environment-jsdom-sixteen
* lint:
  - Runs linter

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

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • 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.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published