santander-dev-week-2024  by digitalinnovationone

REST API for interacting with League of Legends champions

created 1 year ago
257 stars

Top 98.8% on sourcepulse

GitHubView on GitHub
Project Summary

This repository provides a RESTful API for interacting with League of Legends champions, built with Java 21 and Spring Boot 3. It leverages generative AI, specifically OpenAI's GPT and Google's Gemini, to enable users to have conversations with champions, capturing their unique personalities. The project is targeted at developers interested in modern Java development, API creation, and AI integration.

How It Works

The API follows a Clean Architecture pattern, separating concerns into distinct layers: adapters, application (use cases), and domain (entities). This structure promotes modularity and maintainability. The backend uses an in-memory H2 database for storing champion data, facilitating rapid prototyping. Integration with AI models is handled via Spring Cloud OpenFeign, allowing the API to process user requests and generate responses that mimic champion personalities.

Quick Start & Requirements

  • Installation: Requires JDK 21 and an IDE (IntelliJ IDEA, Eclipse, VSCode).
  • Optional: AWS account for deployment, OpenAI/Google accounts for AI integration.
  • Resources: Links to tutorials for JDK 21 and IntelliJ installation are provided.

Highlighted Details

  • Implements Clean Architecture principles for robust design.
  • Integrates with OpenAI (GPT) and Google (Gemini) for AI-powered conversations.
  • Utilizes an in-memory H2 database for efficient data management.
  • Demonstrates deployment to AWS Elastic Beanstalk.

Maintenance & Community

The project was developed during the Santander Dev Week 2024, a collaboration between DIO and Santander. Contribution guidelines are provided via standard Gitflow.

Licensing & Compatibility

The repository does not explicitly state a license.

Limitations & Caveats

The project is presented as a learning and demonstration project from a specific event. While it showcases modern technologies, the lack of an explicit license may impact commercial use or integration into closed-source projects. The AI integration relies on external API keys, which are not included in the repository.

Health Check
Last commit

1 year ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
2 stars in the last 90 days

Explore Similar Projects

Starred by Chip Huyen Chip Huyen(Author of AI Engineering, Designing Machine Learning Systems), Taranjeet Singh Taranjeet Singh(Cofounder of Mem0), and
1 more.

fragments by e2b-dev

0.6%
6k
Next.js template for AI-generated apps
created 1 year ago
updated 1 week ago
Feedback? Help us improve.