https://github.com/seriouslag/pokemon-demo

https://github.com/seriouslag/pokemon-demo

Last synced: 14 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/seriouslag/pokemon-demo
• Owner: seriouslag
• Created: 2023-02-05T01:15:42.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-15T05:14:19.000Z (almost 2 years ago)
• Last Synced: 2024-10-15T02:33:38.763Z (3 months ago)
• Language: TypeScript
• Size: 427 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Pokémon Viewer - A simple Pokémon viewer

This is a simple Pokémon viewer that uses the [PokéAPI](https://pokeapi.co/) to display information about Pokémon.

The goal of this project is to demonstrate steps to refactor a React app.

This project is broken down into different stages, each stage is a branch in this repository. The branches are named after the stage they are in. The main branch is the final stage of the project and is a combination of stages 3-5 to show the differences. Each stage will have a section in the readme that explains the changes made in that stage.

## Stages

- [Stage 1 - Redux State] - The first stage of this project is to demonstrate the combined use of JavaScript and Redux.

  This is how state is currently managed in some frontend Early Payments applications.

- [Stage 2 - TypeScript] - The second stage of this project is to demonstrate the combined use of TypeScript and Redux.

  This state is to show the benefits of using TypeScript.

- [Stage 3 - Generating API code] - The third stage of this project is to show the benefits of generating API code.

  This stage will generate the API code from the PokéAPI.

- [Stage 4 - Using React Hooks] - The fourth stage of this project is to demonstrate the use of React Hooks.

  This stage will use React Hooks to manage state.

- [Stage 5 - Using React Query] - The fifth stage of this project is to demonstrate the use of React Query.

  This stage will use React Query to manage state.

## Getting Started

To get started, clone the repository and install the dependencies:

```bash

git clone

cd pokemon-viewer

npm install

```

## Available Scripts

In the project directory, you can run:

### `npm run dev`

Runs the app in development mode.

Open [http://localhost:5173](http://localhost:5173) to view it in the browser.

The page will reload if you make edits.

### `npm run build`

Builds the app for production to the `dist` 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!

### `npm run start`

Alias for `npm run dev`

### `npm run lint`

Runs the linter on the project.

### `npm run bootstrap`

Bootstraps the project by installing dependencies of packages. This will automatically run when you run `npm install`.

### `npm run downloadApi`

Downloads the PokéAPI and saves it in this project. This will automatically run when you run `npm install`.

### `npm run generateApi`

Generates the API from the downloaded PokéAPI. This will automatically run when you run `npm install`.

### `npm run setup`

Alias for `npm run bootstrap && npm run downloadApi && npm run generateApi`. This will automatically run when you run `npm install`.