Skip to content

Latest commit

 

History

History
122 lines (81 loc) · 5.35 KB

README.md

File metadata and controls

122 lines (81 loc) · 5.35 KB
Raw

(English version | Clique aqui para versão Português-BR)

Pokédex API and Frontend

This project consists of building a Pokédex API and a simple frontend interface to interact with it. The Pokédex API is developed using FastAPI in Python, and the frontend is built using Angular.

The primary objectives of the Pokédex project are as follows:

  • To create an API for managing a list of captured Pokémon with pagination and detailed views.
  • To develop a user-friendly frontend interface for browsing and accessing Pokémon information.
  • To implement additional features such as exporting Pokémon data and documentation generation.
  • Use of Gitflow for development.
  • Unit tests with Pytest.
  • Docker and Docker-Compose for build and deploy.

Author

Barbara Calderon, software developer.

Table of Contents

Overview

The main goal of this project is to create a Pokédex API that manages a list of captured Pokémon with pagination and a simple frontend interface to view the list of Pokémon and their details.

Below, some images.

Pokédex Project Pokédex Project Pokédex Project Pokédex Project Pokédex Project Pokédex Project Pokédex Project

Requirements

API

  1. Base URL: Retrieve data from https://pokeapi.co/api/v2/pokemon.
  2. Pagination: Implement pagination with the default behavior listing all Pokémon if no offset or limit is specified.
  3. Detailed View: Implement a detailed page for each Pokémon similar to https://www.pokemon.com/us/pokedex.
  4. Data Fetching:
    • Use httpx for data fetching.
    • Ensure that the fetched data is sufficient to replicate the details found at https://www.pokemon.com/us/pokedex.
  5. Sorting: Sort the API results alphabetically by Pokémon name.
  6. Export Functionality: Ability to export the sorted list of Pokémon to an XML file.
  7. Documentation:
    • Provide API documentation using Swagger.
    • Follow best practices in API development.

Frontend Requirements

  1. Technologies: Use Angular.
  2. Features: The interface should allow viewing the list of Pokémon and the details of each individual Pokémon.

Run locally

Clone this repo: git clone git@github.com:barbaracalderon/pokedex-api.git

Using Docker and Docker Compose

To run the application using Docker and Docker Compose, follow these steps:

  1. Make sure Docker and Docker Compose are installed on your system.
  2. Navigate to the project directory: cd pokedex-api
  3. Run the application: docker-compose up

This will build and start both the backend and frontend services.

Accessing the Services

  • Frontend: The Angular frontend will be accessible at http://localhost:4200. You can open your browser and navigate to this URL to use the frontend interface.

  • Backend API: The FastAPI backend will be accessible at http://localhost:8000. You can access the API documentation (Swagger UI) at http://localhost:8000/docs.

API Endpoints

Method Endpoint Description
GET /pokemons List Pokémon
GET /data List Pokémon data
GET /docs Swagger documentation from OpenAPI
GET /export Export the list of Pokémon in XML format

Other

Frontend

This project was generated with Angular CLI version 17.3.7.

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The application will automatically reload if you change any of the source files.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.

Final Thoughts

The Pokédex project represents a culmination of efforts to create a comprehensive and user-friendly Pokémon management system. Developed by myself, Barbara Calderon, the project aims to simplify the process of managing and accessing Pokémon data while providing a seamless user experience.

We hope that this system meets your needs and enhances your Pokémon-related activities.