neon0404/torn-client

feat: create more usage examples

Open

#1 aperta il 21 lug 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)TypeScript (0 fork)auto 404
enhancementgood first issuehelp wanted

Metriche repository

Star
 (5 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Currently, the project lacks usage examples

This issue proposes creating a new /examples directory in the repository to host a collection of standalone examples Anything can be an example - from a set of simple scripts to small, self-contained web apps

What's Needed?

  • Create a new top-level /examples directory
  • Each example should be a fully independent project with its own package.json
  • Examples should be designed to run in cloud environments like Stackblitz

Ideas for First Examples

Here are some ideas for great first examples:

  • User attacks analyzer - A simple tool that uses pagination logic to fetch all attacks and displays basic statistics
  • Who ate my chocolate? - A tool that accepts a date range, fetches armory usage from faction.news(), and groups the data by item

Contributing guide

Guida contributor

Direzione di ricerca
Esamina il codice della libreria torn client esistente e la documentazione dell'API di Torn City per creare esempi autonomi nella directory /examples, ciascuno con il proprio package.json. Inizia con semplici script come 'Analizzatore degli attacchi dell'utente' o 'Chi ha mangiato la mia cioccolata?' come suggerito.
Tech stack
typescriptnodejs
Dominio
apideveloper experiencedocumentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
TypeScriptNode.jsGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75