soy4rias / poc-app

Warning: for some reason this project has unstable behavior with vercel [Done].

► Poke App

Developed with the software and tools below.

Table of Contents

• Overview
• Features
• Repository Structure
• Getting Started
  • Installation
  • Usage
  • Tests

---

Overview

This projects is a POC app that aims to demonstrate a flow consuming the PokeAPI.

---

Features

• Show a list of pokemons
• Show pokemon details
• Search pokemons
• Set pokemons as favorites
• Login

---

Repository Structure

└── /
    ├── README.md
    ├── bun.lockb
    ├── components.json
    ├── jest.config.ts
    ├── jest.setup.ts
    ├── next.config.mjs
    ├── package.json
    ├── postcss.config.js
    ├── public
    │   ├── next.svg
    │   ├── placeholder-logo.svg
    │   └── vercel.svg
    ├── src
    │   ├── animations
    │   ├── app
    │   ├── components
    │   ├── hooks
    │   ├── lib
    │   ├── middleware.ts
    │   ├── providers
    │   ├── services
    │   └── store
    ├── tailwind.config.ts
    └── tsconfig.json

---

Getting Started

System Requirements:

• TypeScript: version 5.4.2
• Node: version 20+
• Bun: version 1.0.20+

Pre-requisites

Local development Ensure .env.local file in the project root directory with the following content:

NEXT_PUBLIC_API_URL=
NEXT_PUBLIC_POKE_IMAGE_URL=
NEXTAUTH_SECRET=

⚠️ reference values can be reviewed in the .env.example file

Installation

$ bun install

From source

1. Install the dependencies:

$ bun install

2. Run the application:

$ bun dev

Tests

Run the test suite using the command below:

$ bun run test