PokeApp API

PokeApp Project API is a backend service for interacting with Pokémon data. It provides a set of endpoints for retrieving information about Pokémon, including their species, types, abilities, and weaknesses, using the PokeAPI and other integrated services.

Installation

To get started with the PokeApp API, clone the repository and install the required dependencies.

Prerequisites

Before you begin, ensure that you have the following installed on your local machine:

• Node.js (v18 or higher recommended)
• npm or yarn
• TypeScript (for building the project from source)

Steps

1. Clone the repository:

   git clone <repository-url>
   cd pokeapp-api

2. Install the dependencies:

   npm install

Scripts

The project includes several npm scripts for common tasks:

Development

• Build: Compile the TypeScript files:

  npm run dev:build

• Serve: Start the application using nodemon to automatically restart the server when files change:

  npm run dev:serve

• Start: Start the application in production mode (after building):

  npm start

Testing

• Test: Run tests with Jest in watch mode and collect coverage information:

  npm test

Dependencies

This project uses the following key dependencies:

• axios: Promise-based HTTP client for making requests to external APIs (PokeAPI).
• express: Web framework for building RESTful APIs.
• ioredis: Redis client for caching purposes.
• pokenode-ts: TypeScript wrapper for the PokeAPI.
• typescript: TypeScript compiler for building the project.
• ts-jest: Jest preset for running TypeScript tests.
• ts-node: TypeScript execution environment for Node.js.

Configuration

The application uses the following services and tools:

• PokeAPI: External API for Pokémon data.
• Redis: For caching API responses and improving performance.

Author

Developed by [email protected].