Relocate Me

Get info on different places you might want to live next.

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. Contact

About The Project

The purpose of this app is to give the user information about a place so they can decide if they want to move there. It can be used to see individual statistics of each place or compare cities to each other. There is information about different cities all over the world.

Main Features:

• It will show a list of cities worldwide and display statistics for each one upon clicking it.
• Each city's page will have a summary of the location and various data in several categories.
• Each location is also shown on the map along with a photo of it.

Built With

• React
• Google Maps API
• Teleport API

Getting Started

Installation

1. Get a free API Key at https://teleport.org
2. Get a Google Maps API Key at https://cloud.google.com/maps-platform
3. Clone the repo

   git clone https://github.com/chris-a-phillips/relocate-me

4. Install NPM packages

   npm install

5. Enter your API in .env.local

   const API_KEY = 'ENTER YOUR API';

Usage

Landing Page

City Details

City List

For more examples, please refer to the Documentation

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. 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

LinkedIn - Chris Phillips - phillipsachris@gmail.com

Project Link: https://github.com/chris-a-phillips/relocate-me

Deployed Link: https://please-relocate-me.herokuapp.com/