neon0404/torn-client

feat: create more usage examples

Open

#1 geöffnet am 21. Juli 2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (0 Forks)auto 404
enhancementgood first issuehelp wanted

Repository-Metriken

Stars
 (5 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Überprüfen Sie den vorhandenen torn client Bibliothekscode und die Torn City API Dokumentation, um eigenständige Beispiele im Verzeichnis /examples zu erstellen, jedes mit eigener package.json. Beginnen Sie mit einfachen Skripten wie 'Benutzerangriffsanalysator' oder 'Wer hat meine Schokolade gegessen?' wie vorgeschlagen.
Tech Stack
typescriptnodejs
Domain
apideveloper experiencedocumentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
TypeScriptNode.jsGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75