/juxta-city-data-fe

Primary LanguageJavaScriptMIT LicenseMIT

Find Ur City

Trello Board

Product Canvas

UX Design files

You can find the deployed project at https://www.findur.city

Contributors

Labs 11 - Second Product Cycle

Team Lead:

Kelly Moreira Github | Linkedin

React Developers:

Ana Tulea Github | Linkedin

Benjamin Quackenbush Github

Brian Leonard Github | Linkedin

Conary Beckford Github

Sean Birmingham Github | Linkedin

Labs 7 - First Product Cycle

Team Lead:

Haden Moore Github | Linkedin

React Developers:

Alfonso Ruiz Github

Jack Kim Github

Logan Karnes Github

Zac Smith Github



MIT React code style: prettier Code Coverage Test Coverage

Project Overview

Find Ur City provides city data about important factors in deciding where to live, such as:

  • Population
  • Average resident age
  • Climate
  • Median household income
  • Cost of living
  • Average Commute time
  • and much more!

Find Ur City presents this important data in an intuitive and easy to understand interface.

Key Features

  • Ability to search for a city located in the US
  • Customized 'Recommended Cities' list based on user's survey selections
  • View detailed information about individual cities
  • Ability to save your Favorite cities

Tech Stack

Front end built using:

React

Why?

  • Declarative
  • Component-based
  • Hooks for functional components
  • Popularity

Semantic UI

Why?

  • Popular framework
  • Lots of resources and documentation

Front end deployed to Heroku

Back end built using:

Node + Express

  • Write backend code in JavaScript
  • Fast, unopinionated, minimalist

PostgreSQL

  • Data persistence on Heroku
  • Powerful, open-source

APIs

Find Ur City Data Science API

https://github.com/Lambda-School-Labs/juxta-city-data-ds

API for city data, recommended filter queries, city search queries.

Content Licenses

Image Filename Source / Creator License
search.png Material Design Apache License 2.0

Testing

React Testing Library (Jest)

Why?

  • Made for React Testing
  • Focus on simplicity
  • Minimal configuration

Installation Instructions

Make sure you have PostgreSQL and pgAdmin4 installed on your computer.

git clone https://github.com/Lambda-School-Labs/juxta-city-data-fe.git
cd juxta-city-data-fe
npm install
npm run start

Other Scripts

* start - runs the app in development mode
* build - builds the app for production to the build folder
* test - runs the test watcher in an interactive mode
* eject - copys all config files and transitive dependencies into root
folder
* coverage -  generates a test coverage report

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

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • 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.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

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