tykok / pokeapi-kotlin Goto Github PK

What do you want to add or update 📝

Add the invitation to Discord Server in :

• README.md
• CONTRIBUTING.md
• build.gradle.kts (property)
• mkdocs

Contribution terms 📝

• I agree to follow this project's Contributing guide

Create somes issues templates for this repository.

• Features
• Bugs
• Question / Helps

Create a CI in GitHub with workflow who manage labels according to some triggers.

Implement all Junit Test to check if all endpoints and mapper works.

What do you want to add or update 📝

• Documentation pages (with mkdocs for example)
• Generate GitHub pages with Github action
• Add the link in the README.md

Contribution terms 📝

• I agree to follow this project's Contributing guide

According to the Pokemon documentation here : https://pokeapi.co/docs/v2#evolution-section

Create all classes needed for this call.

• Classes
• Architecture file convention
• Documentation

Make a pull requests templates given for all pull requests in this repository.

According to the Pokemon documentation here : https://pokeapi.co/docs/v2#moves-section

Create all classes needed for this call.

• Classes
• Architecture file convention
• Documentation

According to the Pokemon documentation here : https://pokeapi.co/docs/v2#games-section

Create all classes needed for this call.

• Classes
• Architecture file convention
• Documentation

According to the Pokemon documentation here : https://pokeapi.co/docs/v2#pokemon-section

Create all classes needed for this call.

• Classes
• Architecture file convention
• Documentation

Create a README who explain what is this project and how use it.

Create an API call who get all Pokemon. This API will return a list of NamedApiResource object.

URL : https://pokeapi.co/api/v2/pokemon/?limit=10000000000000

The limit parameters in URL is used to define a limit because by default is 20

Example of an items :

{"name":"bulbasaur","url":"https://pokeapi.co/api/v2/pokemon/1/"}

How to create this feature.

• Use Retrofit / OkHttp for making API calls
• Create a basics function who define the endpoint of the URL
• Create an Interface for this request
• The function who make the request have a parameters who define the limit in URL parameters

According to the Pokemon documentation here : https://pokeapi.co/docs/v2#encounters-section

Create all classes needed for this call.

• Classes
• Architecture file convention
• Documentation

When we add a tag :

git tag -a v1.0-SNAPSHOT -m "Snapshot of PokeAPi"   

And we push it :

git push --tags

We need to change the version in the build.gradle.kts (or in gradle.properties) to the tag we created and next push all.

What do you want to add or update 📝

Improve JavaDoc for every class and properties.

Contribution terms 📝

• I agree to follow this project's Contributing guide

According to the Pokemon documentation here : https://pokeapi.co/docs/v2#machines-section

Create all classes needed for this call.

• Classes
• Architecture file convention
• Documentation

What do you want to add or update 📝

Update JavaDoc link for every classes in the documentation (mkdocs).

Contribution terms 📝

• I agree to follow this project's Contributing guide

What do you want to add or update 📝

Upgrade README.md to include the link to the documentation and see if we can make the URL to tykok.fr.pokeapi.docs.

Contribution terms 📝

• I agree to follow this project's Contributing guide

Add a special file who named "CODE_OF_CONDUCT.md" who explain how we can participate to this project.

To understand what we need to do, read this documentation of GitHub : https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project

According to the Pokemon documentation here : https://pokeapi.co/docs/v2#berries-section

Create all classes needed for this call.

• Classes
• Architecture file convention
• Documentation

According to the Pokemon documentation here : https://pokeapi.co/docs/v2#items-section

Create all classes needed for this call.

• Classes
• Architecture file convention
• Documentation

According to the Pokemon documentation here : https://pokeapi.co/docs/v2#contests-section

Create all classes needed for this call.

• Classes
• Architecture file convention
• Documentation

According to the Pokemon documentation here : https://pokeapi.co/docs/v2#locations-section

Create all classes needed for this call.

• Classes
• Architecture file convention
• Documentation

According to the Pokemon documentation here : https://pokeapi.co/docs/v2#pokemon-section

Create all classes needed for this call.

• Classes
• Architecture file convention
• Documentation