Pokemon API and Frontend Client

This project consists of a Node.js API server that serves information about Pokemon. It is deployed to https://pokedex-api-p7m0.onrender.com/.

A React.js front-end application that consumes this API is deployed to https://pokedex-frontend-lake.vercel.app/. The source code for that application can be found at https://github.com/jdamiba/pokedex-frontend.

Backend: Pokemon API

An API for retrieving Pokemon information.

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/pokemon-api.git
   cd pokemon-api
   

2. Install dependencies:

   npm install
   

3. Start the server:

   node server.js
   

The API will be available at http://localhost:3000/api/.

API Routes

Authentication

Register

• URL: /api/auth/register
• Method: POST
• Description: Register a new user.
• Body:

  {
    "username": "string",
    "password": "string",
    "email": "string"
  }

• Response: User object with token.

Login

• URL: api/auth/login
• Method: POST
• Description: Authenticate a user and receive a token.
• Body:

  {
    "username": "string",
    "password": "string"
  }

• Response: User object with token.

Pokemon Routes

Get All Pokemon

• URL: /api/pokemon
• Method: GET
• Description: Retrieves a list of all Pokemon. Features pagination.
• Query Parameters:
  • page (number, optional) - The page number to return. Default is 1.
  • limit (number, optional) - The number of Pokemon per page. Default is 20.
• Response:

  {
    "pokemon": [array of Pokemon objects],
    "currentPage": number,
    "totalPages": number,
    "totalPokemon": number
  }

Get Pokemon by ID

• URL: /api/pokemon/:id
• Method: GET
• Description: Retrieves a specific Pokemon by its ID.
• Parameters: id (number) - The Pokemon's ID.
• Authentication: Required
• Response: Pokemon object.

Get Pokemon by Name

• URL: /api/pokemon/name/:name
• Method: GET
• Description: Retrieves a specific Pokemon by its name.
• Parameters: name (string) - The Pokemon's name.
• Authentication: Required
• Response: Pokemon object.

Add New Pokemon

• URL: /api/pokemon
• Method: POST
• Description: Adds a new Pokemon to the database.
• Authentication: Required (Admin only)
• Body:

  {
    "name": {
      "english": "string",
      "japanese": "string",
      "chinese": "string",
      "french": "string"
    },
    "type": ["string"],
    "base": {
      "HP": number,
      "Attack": number,
      "Defense": number,
      "Sp. Attack": number,
      "Sp. Defense": number,
      "Speed": number
    }
  }

• Response: Newly created Pokemon object.

Update Pokemon

• URL: /api/pokemon/:id
• Method: PUT
• Description: Updates an existing Pokemon's information.
• Authentication: Required (Admin only)
• Parameters: id (number) - The Pokemon's ID.
• Body: Same as Add New Pokemon, with optional fields.
• Response: Updated Pokemon object.

Delete Pokemon

• URL: /api/pokemon/:id
• Method: DELETE
• Description: Deletes a Pokemon from the database.
• Authentication: Required (Admin only)
• Parameters: id (number) - The Pokemon's ID.
• Response: Success message.

Error Handling

The API returns appropriate HTTP status codes and error messages for invalid requests or server errors. The frontend displays these error messages to the user when appropriate.

Authentication

All Pokemon routes require a valid JWT token. Include the token in the Authorization header:

Authorization: Bearer <your_token_here>

Data Source

This API uses a JSON file obtained from https://github.com/fanzeyi/pokemon.json as its data source.

License

This project is licensed under the MIT License. All information about Pokemon is copyrighted by the Pokémon Company and its affiliates.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.