davidgoldcode / human-rights-first-asylum-fe-a

Basic SPA

For steps on how to work with this repository please see here

Human Rights First Front End

You can find the deployed project at https://a.humanrightsfirstasylum.dev/

Contributors

| Ava Wingfield | Tom Bauer | Ryan Lee | | | :-----------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------: | | | | | | | | | | | | |

• Fork and 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 Front End Repository.
• run: npm install to download all dependencies.
• run: npm start to start your local development server.

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

Key Features and Notes to the Next Group

• Our data science team had issues hooking up their database to our backend, so we never had a populated database. As a result of this all of the Axios requests are made to a locally hosted version of the backend. Thse will obviously all have to be changed once there is a hosted backend with actual data in it.

• Table can be searched by column parameters and sorted by clicking on column headers

• Cases can be bookmarked and saved to a user profile by checking their row's select box and clicking the bookmark button

  • as of now, all this does is cause them to render in the sidebar

• PDF viewer is incomplete and not styled in a very compelling way. We intended to hook it up to the table so that when a row was clicked the PDF associated with that row would render.

• Clicking on a judge name in the judge table will take you to a page with some expanded info and basic plots -This judge page was created at the end and we did virtually no styling formatting with it -Other than the pie chart, the formulas for the other sample charts are hard coded and will need to be fixed once the database is actually populated beyond test data

• Data on judge and case table can be downloaded using the relevant buttons - however, the results of the PDF downloader are hardcoded for the moment since there is no data on the deployed backend. Regardless of which case PDF you select to download, it will pull the same sample PDF.

• Annoying bug that I ran out of time to fix - if there are any saved judges, as soon as you save a case, the judges no longer render. The issue exists in the SideDrawer component

Front end deployed to AWS

Back end built using: AWS

Backend details

Read backend details at https://github.com/Lambda-School-Labs/human-rights-first-asylum-be-a

APIs

Authentication API here

Authentication done via Okta

Installation Instructions

See https://docs.labs.lambdaschool.com/labs-spa-starter/

Other Scripts

• start - starts the production server after a build is created

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, 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.

Documentation

See [Backend Documentation](🚫link to your backend API SWAGGER DOCS here) for details on the backend of our project.