andreferreiradlw / pokestats Goto Github PK

View Code? Open in Web Editor NEW

26.0 3.0 3.0 5.69 MB

The Pokédex powered by PokeApi

Home Page: https://pokestats.gg

License: MIT License

JavaScript 1.46% TypeScript 98.54%

pokemon pokedex pokeapi pokestats

pokestats's Introduction

PokeStats.gg is an online encyclopaedia of Pokémon species containing information such as Pokédex entries, descriptions, evolution chains, moves, stats and much more!

Getting Started

Install dependencies

  $ yarn install

Run project locally

  $ yarn run dev

Linting

  $ yarn run lint

Code Formatting

  $ yarn run prettier

Roadmap

✅ Homepage (Autocomplete + Infinity Scroll)
✅ Pokemon Page
✅ Type Page
✅ Static Generated Pages
✅ Typescript Refactoring
✅ Generation 8 Pokemon + Legends: Arceus (some data is incomplete)
✅ Move Page
🛠️ Encounters & Item Maps
   🛠️ Kanto (Gen I)
   🗒️ Johto + Kanto (Gen II)
   🗒️ Hoenn (Gen III)
   🗒️ Sinnoh (Gen IV)
   🗒️ Unova (Gen V)
🗒️ Headbutt Tree Encounters Map
🗒️ Item Page
🗒️ Berry Page
🗒️ Dark Mode

Contributing

PokeStats.gg is an open source project, and contributions of any kind are welcome and appreciated. Open issues, bugs, and feature requests will be listed on the issues tab and labeled accordingly. Feel free to open bug tickets and make feature requests that aren't already on the roadmap. Easy bugs and features will be tagged with the good first issue label.

Checkout CONTRIBUTING.md to learn more about the project and how to contribute.

Aknowledgements

PokéApi for the data and images (without it, this project would not be possible), duiker101 for the great SVG Type Icons, Gabb-c for the NodeJS wrapper with Typescript support, msikma for all the item sprites, HybridShivam for the compressed images for each Pokemon and their varieties

License

MIT

Copyright Notice

This is an unofficial, non-commercial, fan-made app and is NOT affiliated, endorsed or supported by Nintendo, Game Freak and The Pokémon Company in any way. The images used are © Nintendo/Creatures and Inc./GAME FREAK Inc. Pokémon and Pokémon character names are trademarks of Nintendo. Everything else, including the code, is governed by the MIT license.

Donate

Please consider donating if you think pokestats is helpful to you and want to see the project evolve ❤️

pokestats's People

Contributors

Stargazers

Watchers

Forkers

haleclipse dimorphic kkpan11

pokestats's Issues

Autocomplete submit on Enter keypress.

Submit the first recommended Pokémon.

Infinite Pokémon list scroll

Showcasing 25(?) at a time with a current maximum of 151 Pokemons.

Refactor PokeApi Service Worker into Workbox

Created this issue to refactor the current existing code in pokeapi-sw.js based on the pokeapi-js-wrapped service worker.

The objective here is to create code consistency between this logic and the rest of the Workbox routes. When I tried to emplement similar logic with Workbox, the service worker is saving all the opaque responses and thus, generating massive cache sizes and quickly filling the storage quota.

When I try to filter out the opaque responses that have status code 0 with Workbox's CacheableResponsePlugin, even though the image responses return with status code 200, they are not getting cached.

Remove "arrow up" char on the Details component

Pokeapi serves data just as it is scraped from the Nintendo Pokemon ROMs. Thus sometimes it contains some hidden strange characters which were used as a hack to separate text.

Specifically, in the details pane, you are rendering the flavor text for a specific Pokemon. These almost always contain that char. Browsers render it as an arrow pointing up.

You can use this code to get rid of this annoyance:

        # Page breaks are treated just like newlines.
        # Soft hyphens followed by newlines vanish.
        # Letter-hyphen-newline becomes letter-hyphen, to preserve real
        # hyphenation.
        # Any other newline becomes a space.
        html = flavor_text.replace(u'\f',       u'\n') \
                          .replace(u'\u00ad\n', u'') \
                          .replace(u'\u00ad',   u'') \
                          .replace(u' -\n',     u' - ') \
                          .replace(u'-\n',      u'-') \
                          .replace(u'\n',       u' ')

Reference:

veekun/pokedex#321
veekun/pokedex#218

Cache images

This is just a suggestion.

This project caught my eyes, it's very neat and provides a lot of info. I was thinking that maybe you could use https://github.com/PokeAPI/pokeapi-js-wrapper and especially its feature to cache images:

https://github.com/PokeAPI/pokeapi-js-wrapper#caching-images

Just enabling the SW without actually using the wrapper would be a huge benefit for subsequent page loadings.

Increase Expiration of Cached Images

Currently, the service worker is only caching image responses from Github for 5 minutes. Preferably, we would like to cache these for a much longer period (at least a month).