https://github.com/guicheffer/only-pizza-burger-or-sushi
Only 🍕, 🍔 or 🍣 finder built in React + Redux + Redux-Saga and TypeScript.
https://github.com/guicheffer/only-pizza-burger-or-sushi
mini-app react redux redux-saga reselect typescript vue yarn yelp
Last synced: 8 months ago
JSON representation
Only 🍕, 🍔 or 🍣 finder built in React + Redux + Redux-Saga and TypeScript.
- Host: GitHub
- URL: https://github.com/guicheffer/only-pizza-burger-or-sushi
- Owner: guicheffer
- Created: 2020-10-18T20:44:35.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-19T20:47:00.000Z (about 5 years ago)
- Last Synced: 2025-02-25T23:52:32.925Z (8 months ago)
- Topics: mini-app, react, redux, redux-saga, reselect, typescript, vue, yarn, yelp
- Language: TypeScript
- Homepage: http://only-pizza-burger-or-sushi.guicheffer.me/
- Size: 2.13 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🍕 [Only "Pizza", "Burger" or "Sushi" Mini-App](http://only-pizza-burger-or-sushi.guicheffer.me/)
This is a mini POC/playground to display a few restaurants in Berlin with the "Pizza", "Burger" or "Sushi" categories.
- [The **Demo version** here](http://only-pizza-burger-or-sushi.guicheffer.me/)
## Summary
- [Demo](http://only-pizza-burger-or-sushi.guicheffer.me/)
- [Requirements](#requirements)
- [Available Scripts](#available-scripts)
- [Quick preview](#quick-preview)
- [Tests Coverage](#tests-coverage)
- [Ideas](#ideas)
- [Learn more](#learn-more)
## Requirements
- _Node_ = `14.*`
- _Yarn_ = `1.*`
## Available Scripts
In the project directory, you might run:
### `make start`
It also correctly bundles React in production mode and optimizes the build for the best performance and extract it to the `build` folder and start the application.
### `make dev`
**ps**. Remember you can also use production's URL directly [here](http://only-pizza-burger-or-sushi.guicheffer.me/).
Runs the app in the development mode. 🔥
Make sure you manually open [http://localhost:3000](http://localhost:3000) to view it in the browser.
### `make test-stuff`
Launches the test runner in the interactive watch mode.
#### `make test-coverage` (run to generate the coverage reported by Jest's deps)
This will generate a coverage folder with more details to be exported afterwards.
### `make i` | `make install`
Install dependencies from yarn's package.json.
### `make help`
Please execute that in order to be aware of what commands you might be able to run.
## Quick preview
## Tests Coverage
## Ideas
- [ ] **UX**
- I understand there are many things and many other features that could be added in – therefore, I wasn't really worried since I would like to spend, like recommended, max 4 hours in this little POC;
- [ ] **Acessibility**
- I'm really sorry but I wasn't very successful in Acessibility here - I could have that improved a lot;
- ...honestly, acessibility looks terrible! 😔
- [ ] **Architectural**
- The simple architecture choices here were taking agility into account, that's why I considered not improving it a lot;
- Timeouts
I haven't included any, but would be good if I had...
- Tests
- omg, there were lots of spaces for tests here, however, I only added some because of time-spacing :(
- [ ] **Performance**
- I believe there's a lot of space for performance here;
- [ ] **Reusable Code**
- I tried my best, however, I knew if I had more time, (as I've been a bit busy recently), I would tackle it to improve a bit the performance.
- I also wanted to add [Storybook](https://storybook.js.org/) on this project but then, time expired a bit :(
- We could use the components from the `components/shared/` folder in order to migrate our Storybook comps, for example.
- **ps**. I also added some comments across the codebase to explain a bit better how things are separated as per the concerns;
## Learn More
Visit my corner on the web: [guicheffer.me](http://guicheffer.me)