A city metrics app to help find the perfect city for you!
- View useful metrics, including population, age, cost of living, income, and more!
- Currently features information on 1200+ US cities, with more to come
- Select up to three cities to compare side-by-side
- Future predictions coming soon
| Adonis Puente | Cameron Honis | Peter Wood |
|---|---|---|
 |
||
 |
|
Front End deployed via AWS Amplify
Back End deployed via Heroku
Data Science deployed via AWS Elastic Beanstalk
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 Front End Documentation for details regarding the Front end of our project.
See Data Science Documentation for details regarding the Data Science of our project.
Tables
| Method | Endpoint | Description | Required Data |
|---|---|---|---|
| GET | /cities/all | List of city/state objects | |
| GET | /cities/city/:cityid | Get city by it's ID | |
| GET | /cities/all-long | Caution: should never hit this endpoint. Gets list of entire database city objects | |
| GET | /cities/avg | Get entire DB dataset Average of all cities | |
| GET | /cities/filter | Returns list of city names providing filter object | input: {population?: {min, max}, studio? : {min, max}, onebr -> fourbr?: {min, max}, hourly_wage?: {min, max}, annual_wage?: {min, max}, walkscore?: {min, max}} |
| GET | /cities/compare | Provides a list of city names and returns all list of all given cities data. Validates user and adds to searches |
| Method | Endpoint | Description | Required Data |
|---|---|---|---|
| POST | /users/user | Add a new User | User {username} |
| POST | /users/:userid/fav/:cityName | ||
| POST | /users/:userid/fav | Adds/Removes favcity from user data | cityname |
| POST | /users/:userid/update-preferences | Updates category preferences | input: {studio, onebr, twobr, threebr, fourbr, hourly_wage, annual_wage, walkscore} |
| GET | /users/:userid | Gets user data by ID | |
| GET | /users/getuserinfo | Returns User by Authentication | |
| GET | /users/favs | List current User's favorite cities | |
| PUT | /users/user/:userid | Update full User | User |
| PATCH | /users/user/:userid | Update specific field in User | username |
| DELETE | /users/user/:userid | Delete User by ID |