Skip to content

NathanaelAma/LoRDeckTrackerServer

Repository files navigation

Legends of Runeterra Typescript Backend

Description

Elevate your Legends of Runeterra experience with my back-end, a versatile Type-Script-powered back-end API designed to unlock new possibilities for developers and players alike.

Key Features

  • Seamless User Authentication: Securely create and manage user accounts, integrating with your existing Legends of Runeterra account for a unified experience.

  • Region Status Monitoring: Stay informed about the health and performance of Legends of Runeterra servers in your specific region, ensuring optimal gameplay.

Future Potential:

This foundation paves the way for exciting expansions:

  • Card Data and Match History: Deepen player engagement by querying in-depth card details and analyzing personal match history, fueling strategic optimization and deck-building insights.

  • Customization and Expansion: Extend functionality through additional API endpoints and features, tailoring the experience to specific community needs and innovative project ideas.

Getting Started

Follow the instructions to set up your development environment.

Setting up:

  1. Prerequisites:

    • Node.js (version 16 or later) and npm installed on your system.
    • A text editor or IDE of your choice (e.g., Visual Studio Code, Neovim).
    • A database(MongoDB preferred), can be local for testing.
  2. Clone the Repository:

    git clone https://github.com/NathanaelAma/lor_deck_tracker.git
    
  3. Install Dependencies:

    cd lor_deck_tracker
    npm install
    
  4. Configuration:

    • Create a .env file in the root directory and replace placeholders with your database credentials, Riot API key, and other configuration values.
  5. Start the Server:

    npm run dev
    

Technical Stack:

TypeScript: Programming language

Express.js: Web framework

Contributing:

Embrace the open-source spirit and contribute to shaping the future of this project! Refer to the CONTRIBUTING.md file for details.

License:

This project is licensed under the MIT License. See the LICENSE file for details.