melikealtin / travel-brew

TravelBrew ☕

TravelBrew

Explore nearby gas stations, cafés, and restaurants with this awesome app!

View Code · Report Bug · Request Feature

Table of Contents

1. About the Project
   • What is TravelBrew ?
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Project Team
7. License

About the Project ✨

❔ What is TravelBrew?

TravelBrew is a mobile application designed to assist travelers in discovering the best coffee and cozy spots in the places they visit. The app empowers users to explore top-notch venues that cater to their essential needs, such as coffee, sandwiches, seating areas, and restrooms, while they travel through different cities.

Click for Documentation

🗝️ Key Features:

• Find Cafes: Easily locate the best cafes in the city you're traveling to.
• Filtering Options: Filter cafes based on your preferences (coffee, sandwich, seating area, restroom, etc.).
• User Reviews: Access reliable recommendations by browsing through reviews from fellow travelers and locals.
• Map Integration: View cafes on the map and quickly find the ones nearest to you.
• Favorite Places: Add your favorite cafes and spots to your list for quick access.

💻 Built With

Back to the Top ↑

🏁 Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example 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

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Get a free API Key at developers.google.com

2. Clone the repo

   git clone https://github.com/arzucaner/travel-brew

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

5. Start

    npm expo start

Back to the Top ↑

📱 Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples, and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

🗺️ Roadmap

• Create React Native App
• Add API
• Add Expo and npm
• Add pages
• Add and organize the readme

See the open issues for a full list of proposed features (and known issues).

Back to the Top ↑

🤝 Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

👩‍💻 Project Team

• Arzu CANER - GitHub | LinkedIn
• Ezgi EFE - GitHub | LinkedIn
• Melike ALTIN -GitHub | LinkedIn
• Yağmur Baran KARAKUŞ - GitHub | LinkedIn

Back to the Top ↑

📜 License

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