neon0404/torn-client

feat: create more usage examples

Open

#1 opened on Jul 21, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (0 forks)auto 404
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (5 stars)
PR merge metrics
 (PR metrics pending)

Description

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 direction
Review the existing torn client library code and Torn City API documentation to create standalone examples in the /examples directory, each with its own package.json. Start with simple scripts like the 'User attacks analyzer' or 'Who ate my chocolate?' as suggested.
Tech stack
typescriptnodejs
Domain
apideveloper experiencedocumentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptNode.jsGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75