Skip to content

akashtalole/RampForgeAI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RampForgeAI

AI-powered developer onboarding platform that transforms weeks of traditional onboarding into hours of focused learning.

Project Structure

RampForgeAI/
├── frontend/          # NextJS frontend application
├── backend/           # FastAPI backend application
├── docker-compose.yml # Docker development environment
└── README.md         # This file

Quick Start

Prerequisites

  • Node.js 18+
  • Python 3.11+
  • Docker and Docker Compose (recommended)

Development with Docker (Recommended)

  1. Clone the repository

  2. Start all services:

    docker-compose up --build
  3. Access the applications:

Manual Development Setup

Backend Setup

  1. Navigate to backend directory:

    cd backend
  2. Create virtual environment:

    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
  3. Install dependencies:

    pip install -r requirements.txt
  4. Copy environment file:

    cp .env.example .env
  5. Start the backend:

    cd app
    python main.py

Frontend Setup

  1. Navigate to frontend directory:

    cd frontend
  2. Install dependencies:

    npm install
  3. Start the development server:

    npm run dev

Features Implemented

Task 1: Project Structure and Core Configuration ✅

  • ✅ NextJS project with TypeScript and Tailwind CSS
  • ✅ FastAPI backend with proper project structure
  • ✅ Docker development environment
  • ✅ Health check endpoints
  • ✅ Frontend-backend connectivity verification

Design System

  • Colors: Deep purple (#6750A4), Light lavender (#F2EFF7), Teal (#50A482)
  • Typography: Space Grotesk (headlines), Inter (body), Source Code Pro (code)
  • Framework: Tailwind CSS with custom configuration

API Endpoints

  • GET / - Root endpoint
  • GET /api/health - Health check
  • GET /api/v1/status - Detailed API status
  • GET /api/docs - Interactive API documentation

Environment Variables

See backend/.env.example for all available configuration options.

Next Steps

The project is ready for implementing the next tasks:

  • Authentication and user management system
  • Core UI layout and navigation components
  • MCP client infrastructure
  • AI integration services

Testing

Run the setup test script to verify all components are working:

chmod +x test-setup.sh
./test-setup.sh

About

RampForgeAI intelligently transfers project knowledge from departing devs to new hires.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors