/wise-old-man

The Open Source Old School Runescape progress tracker.

Primary LanguageTypeScriptMIT LicenseMIT

Wise Old Man

🔗 www.wiseoldman.net

The Open Source Old School Runescape progress tracker.

MIT license Core repo

The Wise Old Man is a web app (and API) that measures your Old School Runescape player progress. Built on top of the OSRS hiscores, it allows you to keep track of your gains, participate in group competitions, collect achievements and much more.

Website | Discord | Patreon


👪 Related projects

Although this is the core repository, some related repositories have been created to expand the functionality of this project.


🛠️ API

We also offer a REST API for developers and encourage you to create your own apps and integrations with it. You can read the API documentation at: https://wiseoldman.net/docs


📚 Project structure and stack

The repository is currently divided into 3 components:

  • Server: (The backend & API)

    • Runtime: Node.js
    • Language: TypeScript
    • Database: PostgresSQL
    • Caching: Redis
    • Message Queue: BullMQ
    • API Framework: Express
    • ORM: Prisma
    • Test Runner: Jest
  • App: (The web app)

    • React.js
    • Redux: State management
    • Reselect: Selector memoization
  • Docs: (The API documentation)

    • Framework: Docusaurus

💬 Suggestions and bugs

Have a suggestion or a bug to report? Click here to create a issue

Have something else you'd like to discuss? Join us on discord


🤝 Contributing

Each component of the repository has it's own build and development process, check the documentation for each below:

Help expand and improve the Wise Old Man API: Server / API Development Guide

Help expand and improve the Wise Old Man Web App: App Development Guide

Help update or improve the Wise Old Man API Docs: Docs Development Guide