abdenny/Relocatable

Relocatable is a web app built in React to determine how a user’s salary fares relative to the cost of living across America.

Relocatable

Relocatable determines how a user’s salary fares relative to the cost of living across America.


. View Live · View Demo ·

Table of Contents

• About the Project
  • Built With
• Usage
• Getting Started
  • Prerequisites
  • Installation

• Contributing
• Contact

About The Project

Built With

Tech:

• React
• Redux
• React Router
• Material UI
• React Bootstrap

APIs:

• Numbeo
• Unsplash

Usage

Relocatable allows users to search for cities, input their salary, and to see their cost of living there. Relocatable was designed mobile-first with functionality, responsiveness, and a smooth user experience at the forefront.

MVP (Minimum Viable Product):

• Use React Router to make routes on the SPA
• Lift up state between input and form components, writing parent state to redux store
• Making multiple API calls to populate view page
• Responsive design on all devices

Stretch Goals Completed

• Further dividing the Numbeo API results into subcategories, and displaying these results in their own components
• Animating components mounting and unmounting
• Adding an About page

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install npm@latest -g

Installation

1. Clone the Relocatable

git clone https://github.com/abdenny/Relocatable.git

2. Install NPM packages

npm install

Contributing

Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Austin Denny - Email

Project Link: https://github.com/abdenny/Relocatable