https://github.com/jdmiguel/foodublin

Web application to get information about restaurants in Dublin
https://github.com/jdmiguel/foodublin

axios babel eslint husky jest lintstaged nextjs prettier react redux storybook styled-components typescript yelp-api

Last synced: about 2 hours ago
JSON representation

Web application to get information about restaurants in Dublin

• Host: GitHub
• URL: https://github.com/jdmiguel/foodublin
• Owner: jdmiguel
• Created: 2020-06-30T12:51:01.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-07T07:46:15.000Z (4 months ago)
• Last Synced: 2024-07-07T08:50:49.093Z (4 months ago)
• Topics: axios, babel, eslint, husky, jest, lintstaged, nextjs, prettier, react, redux, storybook, styled-components, typescript, yelp-api
• Language: TypeScript
• Homepage: https://foodublin.vercel.app/
• Size: 10.3 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Foodublin

Web application to find restaurants in Dublin by filtering by name, cuisine or/and Dublin areas and get interesting details about them such as contact info, rating, and opinions. Furthermore, it allows to save restaurants as favorites.

### TECHNOLOGIES

- **REACT**

- **NEXT.JS**

- **REDUX**

- **TYPESCRIPT**

- **STORYBOOK**

- **STYLED-COMPONENTS**

- **JEST**

- **REACT-TESTING-LIBRARY**

- **AXIOS**

- **BABEL**

- **ESLINT**

- **PRETTIER**

- **HUSKY**

- **LINTSTAGED**

### SETUP

- **clone repo**: In your folder, open a new terminal and clone the repo

- **install dependencies**: Execute _yarn_

- **run local server**: Execute _yarn dev_

- **create production files**: Execute _yarn start_

- **run storybook**: Execute _yarn storybook_

- **run test suites**: Execute _yarn test_

### API

The [YELP API](https://docs.developer.yelp.com/docs/fusion-intro#/) was used in this project to get restaurants information.