My Pokédex PWA application

Proof of concept aimed at putting into practice Svelte as a technology.

[!NOTE]
❤️ Feel free to add any improvements or suggestions you consider.

• Inspiration from:
  • LocalStorage with TTL Expiration
  • Pokédex CSS by Bidji

1. Goals
2. Tech Stack
3. Tech specs
4. Installation and running the project
5. Samples
6. Next steps

🎯 Goals

• Create an application (PWA) that displays Pokémons and its stats.
• Integrate the The Pokémon API - PokéAPI to the application.
• Use of Plotly charts to display stats.
• Add the capability of listening to the Pokémon description using the SpeechSynthesis API.
• Use browser's LocalStorage as a means of data persistence.

Features

• Being able to install the application on mobile devices/browser devices. (PWA support).
• Get paginated resources by setting a limit and an offset criteria.
• Persist data by storing responses in browsers's LocalStorage. Default time to live (TTL): 5 days.
• Look for resources given an identifier (Pokémons given a name).
• Display stats using a scatter polar chart.
• Listen to the Pokémon's description by using the SpeechSynthesis API.

Tech Stack

• Front-end
  • Svelte
  • Vite
  • SvelteKit Vite PWA
  • Bulma CSS
• Charts
  • Plotly JavaScript Open Source Graphing Library
• Web APIs
  • LocalStorage
  • SpeechSynthesis

Tech specs

From Sveltve+Vite default template

Svelte + Vite

This template should help get you started developing with Svelte in Vite.

Recommended IDE Setup

VS Code + Svelte.

Need an official Svelte framework?

Check out SvelteKit, which is also powered by Vite. Deploy anywhere with its serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more.

Technical considerations

Why use this over SvelteKit?

• It brings its own routing solution which might not be preferable for some users.
• It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.

This template contains as little as possible to get started with Vite + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other create-vite templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project.

Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate.

Why global.d.ts instead of compilerOptions.types inside jsconfig.json or tsconfig.json?

Setting compilerOptions.types shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding svelte and vite/client type information.

Why include .vscode/extensions.json?

Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project.

Why enable checkJs in the JS template?

It is likely that most cases of changing variable types in runtime are likely to be accidental, rather than deliberate. This provides advanced typechecking out of the box. Should you like to take advantage of the dynamically-typed nature of JavaScript, it is trivial to change the configuration.

Why is HMR not preserving my local component state?

HMR state preservation comes with a number of gotchas! It has been disabled by default in both svelte-hmr and @sveltejs/vite-plugin-svelte due to its often surprising behavior. You can read the details here.

If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.

// store.js
// An extremely simple external store
import { writable } from 'svelte/store'
export default writable(0)

Installation and running the project

The project requires:

• NodeJS

Clone the repository:

git clone https://github.com/christianjtr/svelte-pokedex-pwa.git

Scripts:

Before executing these scripts, you must run npm install in the directory you just downloaded/cloned the codebase.

# Development mode
> npm run dev

# Build mode
> npm run build

# Others, refer to package.json file
# ...

Samples

Live demo

Click on the following link GitHub page project.

Preview

Home page preview

Detail page preview

Next steps

• Improve responsiveness (Lighthouse performance review).
• Better implement Svelte-way of develop applications.