Code Monkey home page Code Monkey logo

max-elixir-pokeapi's Introduction

MaxElixirPokeAPI Logo

build Hex.pm Version Documentation Gitmoji

MaxElixirPokeApi is a Elixir wrapper with auto caching for PokeAPI.

All API references explicit in PokeAPI Doc.

To see all documentation access https://hexdocs.pm/max_elixir_poke_api.

πŸ“₯ Installation

As of v1.1.0, MaxElixirPokeAPI is available on Hex. You can install the package via:

def deps do
  {:max_elixir_poke_api, "~> 1.1.0"}
end

πŸ”„ Usage

To use the resources just call MaxElixirPokeApi.<resource_name>(id_or_name).

List all resources functions at Doc.

MaxElixirPokeApi.berry(1)

To list resources use MaxElixirPokeApi.resource(resource_aton, limit, page).

MaxElixirPokeApi.resource(:berry, 5, 5)

πŸ“‹ Resources atons list

:berry
:berry_firmness
:berry_flavor
:contest_type
:contest_effect
:super_contest_effect
:encounter_method
:encounter_condition
:encounter_condition_value
:evolution_chain
:evolution_trigger
:generation
:pokedex
:version
:version_group
:item
:item_attribute
:item_category
:item_fling_effect
:item_pocket
:location
:location_area
:pal_park_area
:region
:machine
:move
:move_ailment
:move_battle_style
:move_category
:move_damage_class
:move_learn_method
:move_target
:ability
:characteristic
:egg_group
:gender
:growth_rate
:nature
:pokeathlon_stat
:pokemon
:pokemon_color
:pokemon_form
:pokemon_habitat
:pokemon_shape
:pokemon_species
:stat
:type
:language

🀝 Contribute

I value every contribution, no matter how big or small. Here are the steps to get started with contributing:

  1. 🍴 Fork the Repository

    To begin contributing, fork our repository on GitHub. This will create a copy of the project in your GitHub account, allowing you to make changes without affecting the main project directly.

  2. 🀑 Clone the Repository

    After forking the repository, clone it to your local machine using the following command:

    git clone [email protected]:your-username/Max-Elixir-PokeAPI.git

    Be sure to replace your-username with your GitHub username.

  3. πŸ“‚ Create a New Branch

    For each contribution or bug fix, create a new branch from the master branch using a descriptive name that reflects the nature of your changes. This helps keep the project organized and makes it easier for others to review your code.

    git checkout -b feature/your-feature

  4. ✨ Make Changes

    Now, you can start making the necessary changes to the codebase.

  5. πŸ§ͺ Test

    Also, don't forget to write tests for the new functionality or bug fix you're implementing.

    To run unit tests use: mix test

    to run api connection tests use: mix test --include request_api

    Before opening the PR for all tests including api connection.

  6. 😜 Commit and Push

    Once you've made your changes and tested them thoroughly, commit your work using Gitmoji. To create the commit I suggest using gitmoji-cli.

    git add .
    gitmoji -c
    git push origin feature/your-feature
  7. πŸ›ŽοΈ Create a Pull Request

    When you're ready to submit your contribution, navigate to the original repository on GitHub and create a Pull Request (PR) from your branch. In the PR description, provide a clear explanation of your changes, including why they are necessary and any potential impacts.

    I will review your PR as soon as possible. I may provide feedback or ask for additional changes before merging the code.


Special thanks to Tito who made the logo!

max-elixir-pokeapi's People

Contributors

henriqueartur avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

max-elixir-pokeapi's Issues

Encounters

  • Encounter Methods
  • Encounter Conditions
  • Encounter Condition Values

Berries

  • Berries
  • Berry Firmnesses
  • Berry Flavors

Games

  • Generations
  • Pokedexes
  • Version
  • Version Groups

Evolution

  • Evolution Chains
  • Evolution Triggers

Items

  • Item
  • Item Attributes
  • Item Categories
  • Item Fling Effects
  • Item Pockets

Contests

  • Contest Types
  • Contest Effects
  • Super Contest Effects

Locations

  • Locations
  • Location Areas
  • Pal Park Areas
  • Regions

Moves

  • Moves
  • Move Ailments
  • Move Battle Styles
  • Move Categories
  • Move Damage Classes
  • Move Learn Methods
  • Move Targets

PokΓ©mon

  • Abilities
  • Characteristics
  • Characteristics
  • Genders
  • Growth Rates
  • Natures
  • Pokeathlon Stats
  • Pokemon
  • Pokemon Location Areas
  • Pokemon Colors
  • Pokemon Forms
  • Pokemon Habitats
  • Pokemon Shapes
  • Pokemon Species
  • Stats
  • Types

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.