Yelpi

A website built on NextJS to search business from Yelp via GraphQL based on terms and location.

Getting Started

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

Prerequisites

Here is what you need to be able to run the web.

• Node.js (Version: >= 16.x.x < 17).
• Yarn (recommended) but you can use npm instead.
• Requires a Google Maps API Key for generated embeds.
• A free account in Yelp with Developer Beta enabled.

Crafted with:

• Next.js.
• React.
• Stitches.
• Framer Motion.
• SWR.
• Zustand.
• Yelp GraphQL.

Development

1. Clone the repository.

git clone https://github.com/coderdiaz/yelpi.git

2. Go to project folder.

cd yelpi

3. Copy the .env.example and create a new .env file.

cp .env.example .env

4. Install dependencies from package.json.

yarn install

# or
npm i

5. Start the project.

yarn dev

Figma

The proposal design is available on Figma with a minimal screens references (the final version may vary from the current version in the design).

https://www.figma.com/file/R0yeaXPfjhWLOWjmMv6nY7/%F0%9F%AA%B4-Yelpi?node-id=0%3A1

LICENSE

This project it's only for educative use, you can contribute to the project reporting an issue or pushing a feature or fix using a pull request.

Designed and coded by Javier Diaz. Never miss a beat. Questions or doubts contact me to hey[at]coderdiaz.dev.