Skip to content

Pikamuchu/pika-pokedex-nextjs

Repository files navigation

Pikadex

Build Status Codacy Badge codecov

Introduction

Pikadex is a pokemon Pokedex PWA example using JAM stack technologies and serverless infraestructure.

You can browse the running example in Pikadex on Vercel

You can preview source code using codesandbox

Pokedex features

  • Explore pokemons.
  • Search pokemons by name.
  • See pokemons info in the details page.
  • Catch your favorite pokemons with the capture game.

Technical features

  • Progressive Web Application.
  • SSR hybrid rendering.
  • Serverless.
  • Multilanguage.
  • Google Analytics integration.
  • PokeApi integration.

Developing

Built with

Folder structure

  • root: Contains the README.md, the main configuration to execute the project such as package.json or any other configuration files.
  • pages: Contains the source code for application main pages and API endpoints definitions (Next.js constraint).
  • public: Contains the application static resources.
  • src: Contains the application source code.
  • tests: Contains the application tests.

Installing / Getting started

Clone the source code repository

  git clone git@github.com:pikamachu/pika-pokedex-nextjs.git

Install node modules dependencies

  yarn install

Start application in development mode

$ yarn dev

Open http://localhost:3000 with your browser to see the result.

The pages auto-updates as you edit the source files.

Run tests

Run tests with

$ yarn test

Pika commands

You can also use these pika bash command

Usage: pika [command]

where [command] is one of:
   install -> install application dependencies.
   build -> compile application.
   start -> run application in development mode.
   test -> execute application tests.
   format -> auto format project code using prettier.
   docker build -> create application docker image.
   docker start -> run application docker image.