Skip to content

DrZanuff/pokedex-ai

Repository files navigation

PokedexAI

PokedexAI is a small open-source web app that uses the ChatGPT API and the PokemonAPI to provide information about Pokemon based on user prompts. You can test the APP here: PokedexAI

Technologies Used

  • Next.js
  • Vanilla Extract
  • Recoil for State Management
  • React + TypeScript

Background Image

Features

  • Retrieve data from the ChatGPT API to generate Pokemon names based on user prompts
  • Retrieve data from the PokemonAPI to display information about the generated Pokemon, including stats, name, and image
  • Uses CSS to create a Pokedex-like interface for displaying the Pokemon information

Installation

  • Create a .env.local on the root of the project and add two variables with you API keys from OpenAI

    • OPENAI_API=YOUR_API_KEY
    • OPENAI_ORG=OPTIONAL
  • Clone the repository

* Run `npm install`
# or
* Run `yarn`
  • To start the app in development mode
npm run dev
# or
yarn dev
# or
pnpm dev
  • Access the app at http://localhost:3000

Usage

  • Enter a prompt in the input field to generate a Pokemon name
  • Click the "PROMPT" button to retrieve information about the generated Pokemon
  • Information about the Pokemon will be displayed in the Pokedex-like interface

Contributing

Contributions are welcome! Please submit any issues or pull requests to the GitHub repository.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Pokémon and Pokémon character names are trademarks of Nintendo.