Skip to content

BloomTech-Labs/citrics-ds-c

Repository files navigation

Citrics

A city metrics app to help find the perfect city for you!

Deployed link coming soon

Key Features

  • 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

MIT

Contributors

Chase Goldfeld Thomas McDaniel Luis Felipe Urena Chelsea Stump Axel Corro

APIs

Front End deployed via AWS Amplify

Back End deployed via Heroku

Data Science deployed via AWS Elastic Beanstalk

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.

Tech Stack

AWS Elastic Beanstalk

AWS RDS PostgreSQL

FastAPI

BeautifulSoup

Pandas

Numpy

Docker

Documentation

See Backend Documentation for details regarding the backend of our project.

See Front End Documentation for details regarding the Front end of our project.

Architecture

Architecture Diagram

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages