/wise-old-man

The Open Source Old School Runescape progress tracker.

Primary LanguageJavaScriptMIT LicenseMIT

Wise Old Man

www.wiseoldman.net

The Open Source Old School Runescape progress tracker.

API Integration Testing

The Wise Old Man is an Open source project, meaning anyone in the community can contribute code or ideas to add new functionality.

This application measures Old School Runescape player progress. Built on top of the OSRS hiscores, it adds extra functionality like group competitions, player achievements, experience records, etc.

Website | Twitter | Discord


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 documentation at:

API Docs


Project structure and stack

The project is currently divided into 3 components:

  • Server: (The backend & API)
    • Node.js
    • PostgreSQL: Main Database
    • Sqlite: Tests Database
    • Redis & Bull: Job processor
    • Express: API framework
    • Sequelize: ORM
  • App: (The web app)
    • React.js
    • Redux: State management
    • Reselect: Selector memoization
  • Docs: (The API documentation)
    • Next.js (A react framework)

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 project has it's own build and development process, check the documentation for each one 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