Around Me

A React app that uses the Yelp API to find interesting things to do in a certain location.

👩‍💻 Demo

🛠 Built With

• React JS

👷‍♀️ Installation & Set Up

Prerequisites

You need to install Node.js. Then you may choose between:

• npm

  npm i npm@latest -g

  or...

• yarn

  npm i -g yarn

Installation

1. Get an API Key at Yelp's developers website
2. Clone the repo

   git clone https://github.com/danigiorgio/around-me.git

3. Move to the directory

   cd around-me

4. Install packages

   yarn | npm install

5. Create a file called .env.local similar to .env.example and enter your API Key

   REACT_APP_API_KEY= 'ENTER YOUR APIKEY'

6. Run the following command in root folder to start the application in a development environment

   yarn start | npm run start

🐛 Issues

Feel free to file a new issue with a respective title and description. If you already found a solution to your problem, I would love to review your pull request!

🤝 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

📘 License

Distributed under the MIT License. See LICENSE for more information.

✉️ Contact

Daniela Giorgio - @web