Skip to content

Latest commit

 

History

History
89 lines (68 loc) · 3.93 KB

README.md

File metadata and controls

89 lines (68 loc) · 3.93 KB
Raw

Next.js Pokémon API Project

This is a Next.js project that consumes the Pokémon API and displays information about different Pokémon using https://pokeapi.co/docs/v2 image image

Getting Started

To get started with this project, you can either clone this repository or create a new Next.js project from scratch and copy the necessary files.

Prerequisites

To run this project, you need to have Node.js and npm (or yarn) installed on your machine.

Installing

Clone this repository

git clone https://github.com/mfikria/next-pokedex.git

Install dependencies

cd next-pokedex
yarn

Run the development server

yarn dev

Build Production build

yarn build

Start Production build

yarn start

Testing

Unit Test

To run Jest tests, use the command npm test in your terminal or command prompt. This will run all test cases in the *.test.ts files.

yarn test

E2E

To run Playwright tests, use the command in your terminal or command prompt. This will run all test cases in the e2e directory.

npx playwright install
yarn test:e2e

Open http://localhost:3000 in your browser to see the application running.

Project Structure

Here's a brief description of the files and directories:

  • src: This is the root directory for the source code.
    • components: This directory contains reusable UI components organized into subdirectories by category, such as atoms, molecules, and organisms.
      • atoms: Contains small, single-purpose components like badges, cards, and typography.
      • molecules: Contains more complex components made up of smaller components, such as the PokemonCard.
      • organism: Contains larger, more complex components that represent full sections of the UI, like the PokemonDetail and PokemonGrid.
    • svg: Contains SVG images used throughout the app, such as the back.svg and pokemon-logo.svg.
    • hooks: Contains custom React hooks used in the app, such as usePokeApi and useScrollToEnd.
    • mocks: Contains mock data used in tests, such as the pokemon.json file.
    • pages: Contains the pages of the app that are rendered on the server, including dynamic routes like /pokemon/[id]. The files in this directory have a special role in Next.js and must be named correctly to function properly.
    • services: Contains modules that interact with external services or APIs, such as the PokeApi module that communicates with the PokeAPI.
    • styles: Contains global styles used throughout the app, such as the GlobalStyles module.
    • utils: Contains utility modules, such as the colors module for defining the app's color scheme.
    • e2e: End to end test folder

Technology

  • Next.js is a React framework used for server-side rendering, static site generation, and building modern web applications.
  • Storybook is a UI development environment that enables developers to isolate, develop, and showcase UI components in an interactive way. - Emotion is a CSS-in-JS library that allows developers to write CSS styles within JavaScript code.
  • Twin.macro is a library that extends the CSS syntax with the ability to use CSS-in-JS features.
  • Jest is a JavaScript testing framework that is used for unit testing, integration testing, and snapshot testing. It is known for its simplicity, speed, and ease of use.
  • Playwright is a browser automation library that allows developers to automate web applications in different browsers, such as Chrome, Firefox, and Safari. It provides a high-level API that is easy to use and can be integrated with testing frameworks like Jest.

Author

M Fikri A - GitHub Profile

License

This project is licensed under the MIT License - see the LICENSE file for details.