https://github.com/coderdiaz/yelpi
A website built on NextJS to search business from Yelp via GraphQL based on terms and location.
https://github.com/coderdiaz/yelpi
graphql nextjs react stitches swr typescript zustand
Last synced: 11 months ago
JSON representation
A website built on NextJS to search business from Yelp via GraphQL based on terms and location.
- Host: GitHub
- URL: https://github.com/coderdiaz/yelpi
- Owner: coderdiaz
- Created: 2022-09-18T23:51:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-10T14:54:59.000Z (over 3 years ago)
- Last Synced: 2025-04-07T22:35:32.416Z (about 1 year ago)
- Topics: graphql, nextjs, react, stitches, swr, typescript, zustand
- Language: TypeScript
- Homepage: https://yelpi.coderdiaz.dev
- Size: 2.76 MB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 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](https://nextjs.org/).
- [React](https://reactjs.org/).
- [Stitches](https://stitches.dev/).
- [Framer Motion](https://www.framer.com/motion/).
- [SWR](https://swr.vercel.app/).
- [Zustand](https://github.com/pmndrs/zustand).
- [Yelp GraphQL](https://www.yelp.com/developers/graphql/guides/intro).
#### Development
1. Clone the repository.
```sh
git clone https://github.com/coderdiaz/yelpi.git
```
2. Go to project folder.
```sh
cd yelpi
```
3. Copy the `.env.example` and create a new `.env` file.
```sh
cp .env.example .env
```
4. Install dependencies from `package.json`.
```sh
yarn install
# or
npm i
```
5. Start the project.
```sh
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.