https://github.com/misterquestions/pokedex

Web application that displays pokemons and their information
https://github.com/misterquestions/pokedex

Last synced: 11 days ago
JSON representation

Web application that displays pokemons and their information

• Host: GitHub
• URL: https://github.com/misterquestions/pokedex
• Owner: misterquestions
• Created: 2021-01-06T05:19:10.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-07T08:29:42.000Z (about 4 years ago)
• Last Synced: 2025-01-11T17:55:03.321Z (13 days ago)
• Language: TypeScript
• Homepage: https://pokedex.misterquestions.dev
• Size: 393 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Pokedex

Application that lists pokemons and their information

# Libraries & Tools used

- Next.js

- Eslint + Prettier with Airbnb config base (code format and linting)

- Husky + Ling Staged (Ensure code is linted and formatted before commiting)

- Jest (Unit testing)

- Material-UI (Interface components)

- React Hook Form (Better form handling)

# How to run it?

In order to run this project you'll require the following:

- Node.js

- Yarn (optional)

Commands:

- `yarn install`: Installs project dependencies

- `yarn dev`: Starts the development server (with live reload)

- `yarn build`: Builds the application for production

- `yarn start`: Starts the application in production mode (requires build)

- `yarn format`: Formats source using prettier

- `yarn lint`: Only lints source files

- `yarn lint:pretty`: Formats and lints source files

- `yarn type-check`: Checks for type errors in the code

- `yarn test`: Executes unit tests

- `yarn test:all`: Will make format, lint, type checking and testing

# Demo

The application is hosted by Vercel, you can check a live version of it [here](https://pokedex.misterquestions.dev/)