Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
pluvio72 committed Aug 6, 2022
1 parent 3205866 commit e2910f6
Showing 1 changed file with 1 addition and 9 deletions.
10 changes: 1 addition & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
# Pokedex Site
Pokedex site which caches pokemon stats to compare and look through your favourite pokemon using the [pokemon api](https://pokeapi.co/docs/v2).

## Features

- Caches pokemon after fetching data from API for faster interactions
- Async fetching so user can keep interacting while it is fetching
- Uses react-bootstrap API for modular UI interfaces
- Responsive layout (thanks bootstrap)


## Getting Started
You can clone the project from command line with `git clone https://github.com/pluvio72/pokedex-site`.
Then to start the project in development mode on localhost:3000 run these commands:
Expand Down Expand Up @@ -36,4 +28,4 @@ Fetching data from the pokemon API proved to be slow when fetching information a
### Future Ideas (if i had more time)
- Would have implemented some UI tests and e2e integration tests to check application business logic is working
- Added a more robust caching method in combination or instead of local storage as it isn't supported in all environments (safari incognito but there may be more).
- Add prop-types to more files (only added in layout) to make type checking more script between props. (Another possibility is to rewrite in TS but that is larger than using prop-types).
- Add prop-types to more files (only added in layout) to make type checking more script between props. (Another possibility is to rewrite in TS but that is larger than using prop-types).

0 comments on commit e2910f6

Please sign in to comment.