Fdawgs / wise-old-man

The Open Source Old School Runescape progress tracker.

Home Page:https://wiseoldman.net/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Wise Old Man logo

πŸ”— www.wiseoldman.net

The Open Source Old School Runescape progress tracker.

The Wise Old Man is a web app (and API) that tracks and 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)

    • Node.js
    • TypeScript
    • PostgresSQL
    • Redis
    • BullMQ
    • Express
    • Prisma
    • Jest
  • App: (The web app)

    • Next.js 14 (App Router)
    • TailwindCSS
    • HeadlessUI
    • RadixUI
  • Docs: (The API documentation)

    • 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

About

The Open Source Old School Runescape progress tracker.

https://wiseoldman.net/

License:MIT License


Languages

Language:TypeScript 99.1%Language:JavaScript 0.3%Language:PLpgSQL 0.3%Language:Shell 0.1%Language:CSS 0.0%Language:Dockerfile 0.0%