Gauntlet Incept

🚀 Gauntlet-Incept

Gauntlet-Incept is a system designed to generate high-quality educational content tailored to students' knowledge levels and interests.

🚀 Quick Start

This repository contains the code and resources for the Gauntlet-Incept project, which aims to build a system for generating high-quality educational content for K-8 students. Initially, the focus is on developing articles and question banks in specific subject areas.

📚 Documentation

• Project Overview - A detailed description of the project's goals and requirements.
• Implementation Checklist - A comprehensive checklist for project implementation.
• Original Project Brief - The original project brief containing detailed requirements.
• MCP Server Guide - A guide on using Claude Desktop with the model context protocol server.

✨ Features

Project Structure

gauntlet-incept/
├── docs/                  # Documentation files
├── src/                   # Source code
│   ├── api/               # API routes
│   ├── models/            # Data models
│   ├── services/          # Business logic
│   ├── utils/             # Utility functions
│   ├── data/              # Data files
│   ├── tests/             # Test files
│   ├── index.js           # Entry point for the REST API
│   └── mcp.js            # Model context protocol server
└── Dockerfile            # Docker container build file

Core Features

• API Endpoints: Provide multiple core interfaces, including question creation and article generation.
• MCP Server: Integrate with Claude Desktop for model invocation and data interaction.

📦 Installation

Install Dependencies

npm install

Configure Environment Variables

Edit the .env file:

DB_HOST=your-database-host
DB_PORT=5432
DB_NAME=your-database-name
DB_USER=your-database-user
DB_PASSWORD=your-database-password

Start the Project

npm start

Run the MCP Server

npm run mcp

Database Connection

💻 Usage Examples

Basic Usage

Start the Development Environment

npm run dev

Execute Tests

npm test

Perform Code Checks

npm run lint

📄 License

This project is licensed under the MIT License.

Contact Information

[Your Contact Information]