Giter Club home page Giter Club logo

sudiddo / welp Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 780 KB

"Welp" is a Vite-powered React app showcasing how to integrate the Yelp API. This repository walks you through setting up Vite, making API calls to Yelp, and rendering the retrieved data in a user-friendly UI. A hands-on guide for both novice and seasoned developers eager to dive into real-world API utilization.

Home Page: https://welp-one.vercel.app

License: MIT License

JavaScript 96.04% HTML 2.50% CSS 1.45%
javascript maps react tailwindcss yelp yelp-api

welp's Introduction

Welp: Yelp API Integration using Vite-React

Welcome to Welp, a practical exploration into building a modern Vite-powered React application. This project demonstrates how to seamlessly integrate the Yelp API to fetch and present local business data. Utilizing an efficient tech stack with React Query, Tailwind CSS, React Router DOM v6, and Axios, this repository serves as a comprehensive learning material for developers at different stages of their journey.

Project Structure

src 
 ┣ api 
 ┣ assets
 ┣ modules
 ┃ ┣ HomePage (example)
 ┃ ┃ ┣ components
 ┃ ┃ ┗ index.jsx
 ┃ ┗ shared
 ┃ ┃ ┣ components
 ┃ ┃ ┣ hooks
 ┃ ┃ ┗ utils
 ┣ pages
 ┣ App.jsx
 ┣ index.css
 ┗ main.jsx

Features

React Query

  • Purpose: Client-side data-fetching and state management for React applications.
  • Features: Optimized data fetching, caching, and asynchronous updates.
  • Why: Reduces client-side code complexity and improves UI responsiveness.

Tailwind CSS

  • Purpose: Utility-first CSS framework tailored for speedy client-side UI development.
  • Features: Highly customizable, out-of-the-box responsiveness, minimal CSS footprint.
  • Why: Enhances development speed while preserving the ability to customize your client-side UI.

React Router DOM v6

  • Purpose: Client-side routing for React applications.
  • Features: Declarative API, dynamic routing, nested route layouts.
  • Why: Simplifies client-side navigation without reloads, improving user experience.

Axios

  • Purpose: Promise-based HTTP client for making asynchronous requests.
  • Features: Request and response interception, request cancellation, and more.
  • Why: Offers a straightforward way to handle client-side HTTP interactions.

HeroIcons

  • Purpose: Icon library for client-side applications.
  • Features: Wide variety of SVG icons that are easy to integrate.
  • Why: Because I like HeroIcons.

Google Maps React Markers (Alternative)

  • Purpose: Client-side alternative to google-maps-react for map marker rendering.
  • Features: Addresses limitations and issues in google-maps-react.
  • Why: Provides a reliable client-side solution for integrating Google Maps markers.

Getting Started

Clone the Repository

git clone https://github.com/sudiddo/welp.git
cd welp

Install Dependencies

yarn

Setup Yelp API Credentials

  • Create a Yelp Developer Account and obtain your API Key.
  • Create a .env file in the root of your project.
  • Add your Yelp API Key as VITE_YELP_API_KEY=.
  • Run the Application
yarn dev

welp's People

Contributors

sudiddo avatar dependabot[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.