Skip to content

Kai-AnnParsons/Context-Clue

Repository files navigation

Context-Clue

URL: https://contextclue.lovable.app/

Welcome to Context-Clue, a powerful web application designed to help you analyze text for deeper insights, context, and clues. Whether you're a writer, researcher, student, or just curious about text analysis, Context-Clue provides an intuitive interface to explore and understand textual content.

What is Context-Clue?

Context-Clue is an AI-powered text analysis tool that allows you to:

  • Analyze text for key themes, sentiments, and hidden meanings
  • Convert speech to text using advanced speech recognition
  • Generate speech from text with natural-sounding voices
  • Track your analysis history for easy reference
  • Authenticate securely to save and manage your sessions

Built with modern web technologies, Context-Clue offers a seamless experience across devices, combining the power of AI with user-friendly features.

Features

  • Text Analysis: Upload or paste text to receive detailed analysis including sentiment, keywords, and contextual insights.
  • Speech-to-Text: Record or upload audio to convert it into editable text.
  • Text-to-Speech: Transform your analyzed text into spoken audio with customizable voices.
  • Analysis History: Keep track of all your previous analyses for quick access and comparison.
  • User Authentication: Secure login to personalize your experience and save your work.
  • Responsive Design: Works perfectly on desktop, tablet, and mobile devices.
  • Dark/Light Theme: Switch between themes for comfortable viewing.

Getting Started

Prerequisites

  • Node.js (version 16 or higher)
  • npm or yarn package manager
  • A Supabase account (for backend services)

Installation

  1. Clone the repository:

    git clone https://github.com/Kai-AnnParsons/Context-Clue.git
    cd Context-Clue
  2. Install dependencies:

    npm install
  3. Set up environment variables:

    • Create a .env file in the root directory
    • Add your Supabase URL and API key:
      VITE_SUPABASE_URL=your_supabase_url
      VITE_SUPABASE_ANON_KEY=your_supabase_anon_key
      
  4. Start the development server:

    npm run dev

    The app will be available at http://localhost:5173.

Building for Production

To build the app for production:

npm run build

The built files will be in the dist directory.

Usage

  1. Sign Up/Login: Create an account or log in to access all features.
  2. Analyze Text: Go to the Analysis page, paste or upload your text, and click "Analyze" to get insights.
  3. Speech Features: Use the speech-to-text feature to convert audio input, or text-to-speech to hear your text aloud.
  4. View History: Check your analysis history to revisit previous sessions.

Technologies Used

  • Frontend: React, TypeScript, Vite
  • Styling: Tailwind CSS, shadcn/ui components
  • Backend: Supabase (database and serverless functions)
  • AI Services: ElevenLabs for speech processing
  • State Management: React Context
  • Testing: Vitest

Deployment

Context-Clue can be deployed to various platforms. For quick deployment:

  1. Build the project: npm run build
  2. Deploy the dist folder to your hosting service (e.g., Vercel, Netlify, or any static site host)

For full functionality, ensure your Supabase instance is properly configured and accessible.

Contributing

We welcome contributions! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.

Support

If you have any questions or need help, please open an issue on GitHub or contact the maintainers.

About

Context-Clue is a full-stack AI text analysis tool built with React, TypeScript, and Vite. It leverages Supabase for authentication and data persistence, Tailwind CSS/shadcn for responsive UI, and ElevenLabs for natural-sounding text-to-speech. Features include real-time speech recognition, sentiment tracking, and a comprehensive analysis history.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors