Poke API

• Project description
  • Features
  • Architecture
    • Use case diagram
    • Component diagram
    • Deployment diagram
  • Endpoints
  • MongoDB documents structure
• User guide
• Requeriments
• Install guide
  • Containers
• Comments
• License
• Author

Project description

Poke API is a comprehensive RESTful API designed to provide detailed information about Pokémon. It offers a wide range of data, including but not limited to, Pokémon characteristics, abilities, and statistics. This API is perfect for developers building applications that require Pokémon data.

Features

• Comprehensive Pokémon Data: Access detailed information on Pokémon species, abilities, moves, and types.

Architecture

Use case diagram

Component diagram

Deployment diagram

Endpoints

* Auth:
  * POST /api/v1/auth/signup
  * POST /api/v1/auth/signin
  * GET /api/v1/auth/signout
  * GET /api/v1/auth/me
* Pokemon:
  * GET /api/v1/pokemon
  * GET /api/v1/pokemon/:name

MongoDB documents structure

• Trainer:
  • email: string,
  • name: string,
  • nickname: string,
  • password: string,
  • team: string
  • createdAt: date
  • lastConnection: date

User guide

Describe the project structure and how to use it.

.
├── docker-compose.dev.yml
├── docker-compose.prod.yml
├── docker-compose.yml
├── Dockerfile
├── docs
│   ├── assets
│   │   ├── diagrams
│   │   │   ├── component.png
│   │   │   ├── deployment.png
│   │   │   └── usecase.png
│   │   └── pokelogo.png
│   └── poke-api-doc-v1.json
├── ecosystem.config.js
├── jest.config.ts
├── LICENSE
├── nodemon.json
├── package.json
├── package-lock.json
├── README.md
├── src
│   ├── app.ts
│   ├── config
│   │   ├── config.ts
│   │   ├── logger.ts
│   │   └── morgan.ts
│   ├── constants
│   │   └── responses.ts
│   ├── controllers
│   │   ├── auth.controller.ts
│   │   └── pokemon.controller.ts
│   ├── entities
│   │   └── Trainer.ts
│   ├── index.ts
│   ├── interfaces
│   │   ├── pokemon.ts
│   │   └── trainer.ts
│   ├── middlewares
│   │   ├── error.ts
│   │   ├── hashing.ts
│   │   ├── rateLimiter.ts
│   │   ├── token.ts
│   │   └── validate.ts
│   ├── routes
│   │   └── v1
│   │       ├── auth.route.ts
│   │       ├── index.ts
│   │       └── pokemon.route.ts
│   ├── services
│   │   ├── pokemon.service.ts
│   │   └── trainer.service.ts
│   ├── utils
│   │   ├── ApiError.ts
│   │   ├── jwt.ts
│   │   ├── pick.ts
│   │   └── pokemon.ts
│   └── validators
│       ├── auth.validator.ts
│       └── pokemon.validator.ts
├── tests
│   ├── integration
│   │   ├── auth.spec.ts
│   │   └── pokemon.spec.ts
│   ├── unit
│   │   ├── entities
│   │   │   └── trainer.model.test.ts
│   │   └── middlewares
│   │       ├── error.test.ts
│   │       ├── hashing.test.ts
│   │       ├── token.test.ts
│   │       └── validate.test.ts
│   └── utils
│       └── setupTest.ts
└── tsconfig.json

To see the documentation must be run the application in development mode and open this link documentation

Link to demo here

Requeriments

• Node.js version 18 or higher Node.js
• NPM version 8 or higher NPM
• MongoDB version 4 or higher MongoDB
• Docker engine version 24.0.7 or higher Docker
• Docker compose version 2.21.0 or higher Docker compose

Install guide

Below are the instructions to install and run the project in development mode.

git clone https://github.com/christophermontero/pokeapi.git
cd pokeapi
npm install
npm run dev

Containers

This project also support docker engine, for use the API with containers ensure have docker and docker compose installed and run following commands:

docker compose -f docker.compose.yml -f docker-compose.dev.yml up -d

And for production run the following:

docker compose -f docker.compose.yml -f docker-compose.prod.yml up -d

For stop the containers run the following:

docker compose -f docker.compose.yml -f docker-compose.dev.yml stop 

And for destroy the services use the following command:

docker compose -f docker.compose.yml -f docker-compose.dev.yml down 

Comments

If you have any feedback, please reach out at cgortizm21@gmail.com

License

This project is under Apache License.

Author

@christophermontero