Skip to content

ehsanpo/Ritual-AI

Repository files navigation

Ritual-AI

Header Image

Ritual-AI is a comprehensive web application that allows users to explore, understand, and connect with cultural traditions from across the globe. Built with Next.js and powered by AI, it provides an immersive experience for discovering rituals, ceremonies, and cultural practices from different civilizations.

🌟 Features

πŸ” Ritual Explorer

  • Browse through a comprehensive database of cultural rituals and ceremonies
  • Filter by culture, region, occasion, and ritual type
  • Detailed information about each ritual's significance, participants, and elements
  • Beautiful card-based interface with smooth animations

πŸ’¬ AI Chat Assistant

  • Interactive AI-powered chat for in-depth ritual information
  • Ask questions about specific rituals, cultural practices, or traditions
  • Get contextual insights and explanations from our knowledge base
  • Powered by LangChain and OpenAI for intelligent responses

✨ Ritual Generator

  • Create new ritual concepts based on your preferences
  • AI-assisted generation for creative exploration
  • Combine elements from different cultures and traditions
  • Perfect for educational purposes or creative inspiration

πŸ—ΊοΈ Regional Discovery

  • Explore rituals by geographic regions
  • Discover cultural connections and influences
  • Interactive regional browsing experience

πŸ”Ž Smart Search

  • Advanced search functionality across all rituals
  • Search by name, culture, occasion, or keywords
  • Fast and responsive search results

πŸ› οΈ Technology Stack

  • Framework: Next.js with App Router
  • Language: TypeScript
  • Styling: Tailwind CSS
  • UI Components: Radix UI primitives with custom components
  • Animation: Framer Motion
  • AI Integration: LangChain with OpenAI
  • Icons: Lucide React
  • Theme: Next Themes for dark/light mode support

πŸ“š Data Structure

The application includes a rich dataset of cultural rituals with detailed information:

  • Ritual Details: Name, culture/region, occasion, date, type
  • Rich Descriptions: Significance, participants, cultural context
  • Visual Elements: Images and symbolic representations
  • Categorization: Tags, categories, and related rituals
  • Detailed Elements: Specific components and practices within each ritual

πŸš€ Getting Started

Prerequisites

  • Node.js 18.0 or later
  • npm or yarn package manager

Installation

  1. Clone the repository

    git clone https://github.com/ehsanpo/Ritual-AI.git
    cd Ritual-AI
  2. Install dependencies

    npm install
    # or
    yarn install
  3. Set up environment variables

    cp .env.example .env.local

    Add your OpenAI API key and other required environment variables:

    OPENAI_API_KEY=your_openai_api_key_here
  4. Run the development server

    npm run dev
    # or
    yarn dev
  5. Open your browser

    Navigate to http://localhost:3000 to see the application.

πŸ“± Pages and Routes

  • / - Homepage with hero section and feature overview
  • /explore - Main ritual explorer with filtering and search
  • /chat - AI chat interface for ritual discussions
  • /generator - AI-powered ritual generator
  • /regions - Regional exploration of rituals
  • /search - Advanced search functionality
  • /about - About the project and its mission
  • /ritual/[id] - Individual ritual detail pages

🎨 UI Components

The application uses a comprehensive design system built on:

  • Radix UI: Accessible, unstyled components
  • Custom UI Components: Cards, buttons, forms, navigation
  • Responsive Design: Mobile-first approach
  • Dark Mode: System preference detection with manual toggle
  • Animations: Smooth transitions and micro-interactions

πŸ”§ Development

Available Scripts

npm run dev      # Start development server
npm run build    # Build for production
npm run start    # Start production server
npm run lint     # Run ESLint

Project Structure

β”œβ”€β”€ app/                 # Next.js 13 app directory
β”‚   β”œβ”€β”€ api/            # API routes
β”‚   β”œβ”€β”€ globals.css     # Global styles
β”‚   └── (pages)/        # Application pages
β”œβ”€β”€ components/         # Reusable React components
β”‚   β”œβ”€β”€ ui/            # Base UI components
β”‚   └── ...            # Feature-specific components
β”œβ”€β”€ data/              # Static data files
β”œβ”€β”€ hooks/             # Custom React hooks
β”œβ”€β”€ lib/               # Utility functions and AI integration
└── public/            # Static assets

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.


Explore the rich tapestry of human culture through Ritual-AI - where tradition meets technology. 🌍✨

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages