Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 2.69 KB

README.md

File metadata and controls

64 lines (41 loc) · 2.69 KB

Armored Core Garage - Mech Building Assistant

Welcome to Armored Core Garage (ACG), a TypeScript based web application developed to assist Armored Core players in building their custom mechs. This project leverages the power of advanced AI, OpenAI's GPT-4, to guide users interactively through the process, offering real-time stats and tailored advice. Users can ask questions and interact with the AI via an engaging chat interface. The AI is context-aware and can fetch relevant data from a comprehensive database of mech parts based on the user's queries.

Table of Contents

Features

  • AI-powered, user-friendly chat interface for building your mech
  • Real-time calculations of stats, including armor points
  • Comprehensive and interactive database of mech parts
  • Reactive UI that enhances the user experience
  • Utilizes technologies such as TypeScript, Next.js, Tailwind CSS, Drizzle ORM, PlanetScale's MySQL database, and OpenAI Edge, enhanced with user interface libraries like Radix UI and Clerk for user authentication

Setup

First, install the dependencies:

pnpm install

To run the development server:

pnpm run dev

Connect to planetscale db:

pscale connect <database-name>

Navigate to http://localhost:3000 in your browser to view the application.

Usage

Start by selecting the parts for your mech. The AI will guide you through the process and update the stats in real-time. Use the chat interface to ask questions and get personalized advice based on your build.

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page for open issues or create a new one.

License

This project is MIT licensed.

This project is bootstrapped with create-next-app. To learn more about Next.js, take a look at Next.js Documentation.

Deployment

The easiest way to deploy your Next.js app is to use the Vercel Platform, created by the developers of Next.js.

For more details, check out the Next.js deployment documentation.