pokertk/README.md

45 lines
1.6 KiB
Markdown
Raw Normal View History

2023-05-31 18:14:08 +10:00
# PokeRtk = Pokedex + Redux-Toolkit
2023-05-31 14:43:47 +10:00
A simple PokemonCard catalogue frontend app, build with React, Redux-Toolkit, Material-UI. It uses backend powered by [PokeAPI](https://pokeapi.co/).
It's a learning project following [pokedex](https://github.com/s1varam/pokedex). In this project, I practised following skills:
* Use React to create View for FE
* Use redux, react-redux, redux-toolkit (RTK) for state management
* Use storybook to design component
2023-05-31 14:43:47 +10:00
* Use [RTK Query](https://redux-toolkit.js.org/rtk-query/overview) for fetching
2023-05-31 14:43:47 +10:00
Feature of the pokedex application:
2023-05-31 14:43:47 +10:00
* Display list of pokemon cards
* Fetching pokemon cards by region
![fetching by region](README/1_fetching_by_region.gif)
* Filter pokemon cards by type
![filter by type](README/2_filter_by_type.gif)
* Sort pokemon cards by name or ID
![sort by name](README/3_sort_by_id_or_name.gif)
* Filter pokemon cards by search naming
![filter by search](README/4_filter_by_search.gif)
* Show pokemon card detail
![show detail](README/5_click_info_icon.gif)
2023-05-31 18:23:26 +10:00
Deployed on [Netlify](https://pokedex-rtk.netlify.app/)
2023-05-31 14:43:47 +10:00
## Available Scripts
2023-05-31 14:43:47 +10:00
In the project directory, you can run:
2023-05-31 14:43:47 +10:00
* `nvm use`: use node version according to `.nvmrc`
* `yarn start`: run the development server
* `yarn storybook`: start storybook server to check component rendering
* `yarn build`: build the app for production
2023-05-19 00:17:22 +10:00
## TODO
* [ ] Fix css of Filter component
* [ ] Fix Poke logo size via css
* [ ] Add day/night toggle in header
* [ ] Add github icon in header
* [ ] Use material.ui to display pokemon cards
2023-05-31 14:43:47 +10:00
* [ ] Fix round corner of InfoDialog component
* [ ] Add error handling for data fetching across app
* [x] Deploy through netlify