You can find the deployed project at Human Rights First - Blue Witness.
Feel free to reach out if you have any questions about the repo.
| Bruno Paula | Ryder Kline | Joseph Witzke | Dylan Rinella | |
|---|---|---|---|---|
 |
 |
 |
 |
|
| |
||||
 |
|
|
All Labs Engineering Standards must be followed.
Technical Architecture and Userflow Screenshot
Technical Architecture and Userflow Whimsical Board
We are developing an interactive map that identifies reports of police use-of-force across the United States of America for Human Rights First, a not-for-profit independent advocacy and action organization.
- User can view reports of police brutality and obtain sources to do further research
- Users can interact with a map to help visualize where these reports occur
- Users can view a timeline of recent events to see how often these events are occurring
- Administrators have the ability to approve, reject, and CRUD incidents
- Node
- Express
- PostgresSQL
- Yup for validation.
- Swagger/jsdoc
- Okta for authorization
See our Swagger Documentation for information about the endpoints of our server.
Or on your local deploy.
Swagger docs are created using open api v3 notations. The docs are found inline
on the router files in api/**/*Router.js and use the yaml notation format.
The root of the docs is in config/jsdoc.js using the json format.
The following libraries have been used to build and serve the swagger docs live.
The backend is sharing a database with the Data Science Team. The Data Science team will be scraping data into the same database that the backend server pulls data from. The current migrations can be used for testing locally on a development environment as the table schemas should be identical (hopefully).
PORT=
BE_DATABASE_URL=
DS_DATABASE_URL=
OKTA_URL_ISSUER=
OKTA_CLIENT_ID=
LOCAL_DATABASE=
In order for the app to function correctly, the user must set up their own environment variables. You should receive an environment variables notion doc to help you get setup, or reach out to past contributors.
A decent amount of testing has been completed. More may be needed going forward if more functionality is added. Current tests were broken with recent updates and will need slight fixes.
Run 'npm install' to install all necessary dependencies.
Run 'npm run server' to spin up a local development server on port 8000.
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.
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.
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.
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.
Please see pull_request_template.md
Description
Fixes # (issue)
Type of change
Please delete options that are not relevant.
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
Change Status
- [ ] Complete, tested, ready to review and merge
- [ ] Complete, but not tested (may need new tests)
- [ ] Incomplete/work-in-progress, PR is for discussion/feedback
How Has This Been Tested?
- [ ] Test A
- [ ] Test B
Checklist
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] My code has been reviewed by at least one peer
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] There are no merge conflicts
These contribution guidelines have been adapted from this good-Contributing.md-template.
#7efb8d6c90189023e25dc1e19239e83931778488
There is also a function to reformat the data.
#fee018b0b48bad3170f8b0641be22457c002d571
#92c6a439fb5d050e3bc0d51b1c2de20922ef19fe
#415987c7a0b223960ee5e3e232d2878a32d6e82f
#415987c7a0b223960ee5e3e232d2878a32d6e82f