Modified README to add .gif files

README.md

@@ -1,54 +1,37 @@
 # Getting Started with Create React App
 
-A simple PokemonCard catalogue app, build with React, Redux-Toolkit, Material-UI and PokeAPI. 
+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
+* Use [RTK Query](https://redux-toolkit.js.org/rtk-query/overview) for fetching
+
+Feature of the pokedex application:
+
+* 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)
+
+Deployed on [Netlify](https://main--glittery-belekoy-f5e832.netlify.app/)
 
 ## Available Scripts
 
 In the project directory, you can run:
 
-### `yarn start`
+* `nvm use`: use node version according to `.nvmrc`
-
+* `yarn start`: run the development server
-Runs the app in the development mode.\
+* `yarn storybook`: start storybook server to check component rendering
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+* `yarn build`: build the app for production
-
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
-
-### `yarn test`
-
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `yarn build`
-
-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](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `yarn eject`
-
-**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.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
 
 ## TODO
 
@@ -58,3 +41,5 @@ To learn React, check out the [React documentation](https://reactjs.org/).
 * [ ] Add github icon in header
 * [ ] Use material.ui to display pokemon cards
 * [ ] Fix round corner of InfoDialog component
+* [ ] Add error handling for data fetching across app
+* [x] Deploy through netlify

package.json

@@ -6,9 +6,9 @@
     "@emotion/react": "^11.11.0",
     "@emotion/styled": "^11.11.0",
     "@mui/icons-material": "^5.11.16",
-    "@mui/material": "^5.12.3",
+    "@mui/material": "^5.13.1",
-    "@reduxjs/toolkit": "^1.9.3",
+    "@reduxjs/toolkit": "^1.9.5",
-    "framer-motion": "^10.12.8",
+    "framer-motion": "^10.12.12",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "react-lazy-load-image-component": "^1.5.6",
@@ -63,43 +63,43 @@
     ]
   },
   "devDependencies": {
-    "@storybook/addon-actions": "^7.0.11",
+    "@storybook/addon-actions": "^7.0.12",
-    "@storybook/addon-essentials": "^7.0.11",
+    "@storybook/addon-essentials": "^7.0.12",
-    "@storybook/addon-interactions": "^7.0.11",
+    "@storybook/addon-interactions": "^7.0.12",
-    "@storybook/addon-links": "^7.0.11",
+    "@storybook/addon-links": "^7.0.12",
-    "@storybook/node-logger": "^7.0.11",
+    "@storybook/node-logger": "^7.0.12",
-    "@storybook/preset-create-react-app": "^7.0.11",
+    "@storybook/preset-create-react-app": "^7.0.12",
-    "@storybook/react": "^7.0.11",
+    "@storybook/react": "^7.0.12",
-    "@storybook/react-webpack5": "^7.0.11",
+    "@storybook/react-webpack5": "^7.0.12",
-    "@storybook/testing-library": "^0.0.14-next.2",
+    "@storybook/testing-library": "^0.1.1-future.2",
     "@testing-library/jest-dom": "^5.16.5",
     "@testing-library/react": "^13.4.0",
     "@testing-library/user-event": "^13.5.0",
     "@types/jest": "^27.5.2",
-    "@types/node": "^16.18.14",
+    "@types/node": "^16.18.31",
-    "@types/react": "^18.0.28",
+    "@types/react": "^18.2.6",
-    "@types/react-dom": "^18.0.11",
+    "@types/react-dom": "^18.2.4",
-    "@types/react-lazy-load-image-component": "^1.5.2",
+    "@types/react-lazy-load-image-component": "^1.5.3",
-    "@typescript-eslint/eslint-plugin": "^5.56.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.6",
-    "@typescript-eslint/parser": "^5.56.0",
+    "@typescript-eslint/parser": "^5.59.6",
     "babel-plugin-named-exports-order": "^0.0.2",
     "chromatic": "^6.17.4",
-    "eslint": "^8.36.0",
+    "eslint": "^8.41.0",
     "eslint-config-airbnb": "^19.0.4",
-    "eslint-config-prettier": "^8.7.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jsx-a11y": "^6.7.1",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "husky": "^8.0.3",
-    "lint-staged": "^13.2.0",
+    "lint-staged": "^13.2.2",
     "msw": "^1.2.1",
-    "prettier": "^2.8.4",
+    "prettier": "^2.8.8",
     "prop-types": "^15.8.1",
-    "storybook": "^7.0.11",
+    "storybook": "^7.0.12",
     "tsconfig-paths-webpack-plugin": "^4.0.1",
-    "webpack": "^5.76.2"
+    "webpack": "^5.83.1"
   },
   "readme": "ERROR: No README data found!",
   "_id": "pokertk@0.1.0"

public/index.html

@@ -24,7 +24,7 @@
       work correctly both with client-side routing and a non-root public URL.
       Learn how to configure a non-root public URL by running `npm run build`.
     -->
-    <title>React App</title>
+    <title>PokeRTK</title>
   </head>
   <body>
     <noscript>You need to enable JavaScript to run this app.</noscript>