This app uses Yelp APIs to get all the sushi restaurants in Minneapolis. It also shows you details about each restaurant.
Package Manager: NPM (see the bottom section of this ReadMe for how to start the app, note: you will also need to NPM install and set the environment in a config file that I have not committed to this repo due the fact that it contains the API key and should be hidden for security reasons. Please see the How To Run The App section )
Other notable dependencies:
Why TypeScript? TypeScript modularizes applications and helps eliminate bugs by checking data types. It's great for scaling, architecting and data modeling.
Why Foundation CSS? For the purposes of meeting project requirements of avoiding heavily stylized frameworks such as MUI. I've used this very sparringly by importing the CDN. The functionality of Foundation in this app is mostly for responsive purposes and to normalize the CSS across different browsers. Since I'm not importing any pre-built components, the styles are pretty minimal.
Why Sushi? Sushi is one of the superior food categories. According to science, you can tell a lot about a city's restaurant scene by its sushi restaurants.
Why Minneapolis? because!
- Dynamic data loading with infinite scroll
- Responsive UI
- Won't lose your spot scrolling when hitting browser back button on Restaurant Details page
- 404 Page for bad URLs
- Loading spinner shows when data is loading
- Meaningful URLs - change dynamically with the screens
- Restaurant Details page has a shareable URL and will load independently
- Restaurant Details page lets you know if it can't find the restaurant for a given ID
- Meaningful Page titles
- Accessibility-friendly (ARIA roles, alt text, keyboard navigation, color contrasts, minimal animation, meaninful URLs, semantic HTML)
- Fixed top bar
- Clone Repo
- npm install
- add a
config.jsfile in the/src/hooks/apifolder (I can provide the content of this file which contains the API key) - To get past CORS issues, go to this link and click the
Request temporary access to serverwhich creates a third party proxy that lets you get past the Yelp API CORS settings. - npm start (below there is some more information on npm)
🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟🐟
This project was bootstrapped with Create React App.
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.