You can find the deployed project HERE.
| Ian Bautista | Nathan DeSpain | Zachary Peterson | Anthony Navarro | |
|---|---|---|---|---|
 |
|
|
|
- Search for a city and compare its stats to the US National Average
- Add up to 10 cities to comparer
- Authenticate with Okta
Back end built using:
- Java/Spring
This app is authenticated using Okta. Learn more about Okta
Clone this repo and install dependencies with npm
* build - creates a build of the application
* start - starts the production server after a build is created
* test - runs tests in **tests** directory \* eject - copy the configuration files and dependencies into the project so you have full control over them
- Ant Design: A few of the components were built using AntDesign. Learn more about AntDesign here
- Styling: Styling was done primarily using styled components. Learn more about it here
- Custom Maps: Created Utilizing mapbox. Learn more about it here
- Summaries and Photos for the cities: Media was obtained through MediaWiki's API. Learn about it here
- Redux - Redux was used for global state management
- Components were separated into two folders:
- Common: Componets that appear on multiple pages.
- Pages: Folders for components that only appear on one page.
- Styling will be found in the page folders or in the JavaScript files.
- State Management - Find all of your Redux actions/reducers in the state folder
-View our Figma designs and user flow outline on Figma
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.
- 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.
See Backend Documentation for details on the backend of our project.
- Removing cities will not change page unless searchbar is being rendered
- Searchbar styles are slightly off