Skip to content

kuentinozaure/game-guide

Repository files navigation

Game guide

Welcome to Game Guide! 🎲 Your ultimate AI-powered solution for managing board games and accessing game rules. With Game Guide, you get to combine the magic of advanced technology with your passion for board games.

🚀 Features

  • AI-Powered Rule Retrieval: Harness the power of Groq AI to interact with and utilize a cutting-edge language model (LLM). Ask questions about game rules and get instant, detailed responses!

  • Efficient Rule Storage: We use Pinecone as our vector database to store and manage game board rules files. Enjoy lightning-fast searches and organized rule storage.

  • Backend Magic with NestJS: The heart of Game Guide is powered by NestJS, ensuring smooth and scalable backend operations.

🛠️ Installation

Get up and running with just a few commands:

Clone the Repository

git clone https://github.com/kuentinozaure/game-guide.git

Navigate to the Project Directory

cd game-guide

Install Dependencies

npm install

Start the Application

npm start

Visit http://localhost:3000 to start exploring!

🔧 Configuration

Customize Game Guide by updating the .env file. Set your AI service API keys, Pinecone database settings, and other preferences here.