PokeAPI / PokeAPI/pokekotlin

create an offline engine

Open
#157 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Kotlin
Stars
200
Forks
45
PR merge metrics
No merged PRs in 30d

Description

similar to the mock engine previously used in tests, we should provide a Ktor engine implementation that reads from a zip archive of https://github.com/PokeAPI/api-data/ for offline use

https://github.com/UselessMnemonic/Pak would be useful to use here for reading the zip.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the mock engine previously used in tests and reviewing the Ktor engine implementation points. Read the api-data archive layout and investigate Pak for reading the zip. Done means an offline engine can serve the archive data without network access.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.