A city metrics collation app to help find the perfect city for you!
You can find the deployed project at Citrics.
- View useful metrics, including weather patterns, housing prices, job market, demographics, and more!
- Currently features information on the
100largest US cities, with more to come - Select up to three cities to compare side-by-side
- Dig into detailed historical information, trends, and future predictions
- Glance at future predeictions for specific statistics
- Complete an Advanced Search to filter cities with specific requirements
- Provide a more complete list/suggestions for an unsuccessful search
- Determine additional types of data can be shown e.g.: Demographics (age, religion, etc), access to activities (hiking trails, bars, restaurants, etc)
- After looking at a city, I can click on a 'See cities similar to this' feature
- User can search for a city by Zip code
- Styling: model the home page to be more useful. Instead of side bar and 'Get Started' button, incorporate the search bar like this similar app
Backend built using FastAPI:
Our Data Science team collated a variety of metrics and created predictive models. See their repo for more information
| Rachele Edwards | David Horstman | Alan Lee | Lyndsi Williams | Bhavani Rajan |
|---|---|---|---|---|
 |
 |
 |
 |
 |
 |
|
|
|
|
We used the Google Places API to dynamically retrieve the most appropriate cover images for each city in our database.
To use this API, you must provide a valid API key in the environment variable REACT_APP_PLACES_API_KEY, either using a .env file or in the configuration of your deployment.
You can find instructions on getting an API key in this Medium article.
We used the Open Weather API to retrieve and display the current weather for each city in our database.
To use this API, you must provide a valid API key in the environment variable REACT_APP_OPEN_WEATHER_API, either using a .env file or in the configuration of your deployment.
You can find instructions on getting an API key in this article.
See Backend Documentation for more information on the APIs used by our Data Science team.
User Flowchart
Wireframe
Engineering Architecture Flowchart
Icons: We got out icons from Icons8. Small icons are 48px, Large is 96px.
Run the following in your shell of choice:
git clone https://github.com/Lambda-School-Labs/Labs26-Citrics-FE-TeamB
cd Labs26-Citrics-FE-TeamB
npm i
npm start
You will then see the App running in your browser at http://localhost:3000/
* build - creates a production-ready build
* test - run unit tests in __tests__ directory
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.