Thanks to visit codestin.com
Credit goes to github.com

Skip to content

PumaAI-v2/site

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

28 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

PumaAI - Your Platform for AI

PumaAI Screenshot

๐Ÿš€ Overview

PumaAI is a modern, intelligent AI assistant platform built with React and powered by OpenAI's GPT models. It features a sleek dark theme, responsive design, and comprehensive dashboard for managing AI conversations, settings, and user analytics.

โœจ Features

  • ๐Ÿค– AI Assistant: Real-time chat with OpenAI GPT integration
  • ๐Ÿ’ฌ Multi-Chat Support: Manage multiple conversation threads
  • โšก Quick Actions: Pre-defined prompts for common tasks
  • ๐Ÿ“Š Usage Analytics: Track your AI interactions and usage patterns
  • ๐Ÿ”ง Model Switching: Choose between different AI models
  • ๐Ÿ”’ Privacy Controls: Comprehensive privacy settings and data management
  • ๐ŸŽจ Modern UI: Glass morphism design with dark theme
  • ๐Ÿ“ฑ Responsive: Works seamlessly on desktop and mobile devices
  • ๐Ÿ” Authentication: Secure user authentication system

๐Ÿ› ๏ธ Technology Stack

  • Frontend: React 19 with Vite
  • Routing: React Router DOM v7
  • Styling: Modern CSS with CSS Grid and Flexbox
  • AI Integration: OpenAI GPT API
  • Deployment: GitHub Pages
  • Build Tool: Vite

๐Ÿš€ Quick Start

Prerequisites

  • Node.js 18+ and npm
  • OpenAI API key (for full AI functionality)

Installation

  1. Clone the repository

    git clone https://github.com/PumaAI-v2/homepage.git
    cd homepage/homepage
  2. Install dependencies

    npm install
  3. Set up environment variables

    cp .env.example .env

    Edit .env and add your API keys:

    VITE_OPENAI_API_KEY=your_openai_api_key_here
    VITE_OPENAI_API_URL=https://api.openai.com/v1
    VITE_APP_NAME=PumaAI
    VITE_ENVIRONMENT=development
  4. Start development server

    npm run dev
  5. Open in browser Navigate to http://localhost:5173

Production Build

npm run build
npm run preview  # Preview the production build locally

Deploy to GitHub Pages

npm run deploy

๐Ÿ”ง Configuration

Environment Variables

Create a .env file in the homepage directory with the following variables:

# Required for AI functionality
VITE_OPENAI_API_KEY=your_openai_api_key_here

# Optional configurations
VITE_GOOGLE_ANALYTICS_ID=your_ga_id_here
VITE_APP_VERSION=2.0.0
VITE_ENVIRONMENT=production

# Feature flags
VITE_ENABLE_OPENAI=true
VITE_ENABLE_ANALYTICS=true

API Keys Setup

  1. OpenAI API Key:

    • Go to OpenAI Platform
    • Create a new API key
    • Add it to your .env file as VITE_OPENAI_API_KEY
  2. Google Analytics (Optional):

    • Set up a Google Analytics 4 property
    • Add the Measurement ID to VITE_GOOGLE_ANALYTICS_ID

๐Ÿ“ Project Structure

homepage/
โ”œโ”€โ”€ public/                 # Static assets
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ components/        # React components
โ”‚   โ”‚   โ”œโ”€โ”€ dashboard/     # Dashboard-specific components
โ”‚   โ”‚   โ”œโ”€โ”€ Footer.jsx     # Site footer
โ”‚   โ”‚   โ”œโ”€โ”€ Hero.jsx       # Landing page hero
โ”‚   โ”‚   โ”œโ”€โ”€ Login.jsx      # Authentication components
โ”‚   โ”‚   โ””โ”€โ”€ Register.jsx
โ”‚   โ”œโ”€โ”€ contexts/          # React contexts
โ”‚   โ”œโ”€โ”€ services/          # API services
โ”‚   โ”œโ”€โ”€ config/            # Configuration files
โ”‚   โ”œโ”€โ”€ App.jsx           # Main app component
โ”‚   โ””โ”€โ”€ main.jsx          # App entry point
โ”œโ”€โ”€ .env.example          # Environment variables template
โ”œโ”€โ”€ vite.config.js        # Vite configuration
โ””โ”€โ”€ package.json          # Dependencies and scripts

๐ŸŽฏ Dashboard Features

AI Assistant

  • Real-time chat with OpenAI GPT
  • Multiple conversation threads
  • Quick action buttons for common prompts
  • Message history and context awareness

Settings

  • User profile management
  • API key configuration
  • Theme and display preferences
  • Notification settings

Usage Statistics

  • Chat activity tracking
  • API usage monitoring
  • Response time analytics
  • Cost tracking (when applicable)

Model Switching

  • Choose between GPT models
  • Temperature and parameter controls
  • Custom system prompts

Privacy & Security

  • Data retention controls
  • Export conversation history
  • Delete account functionality
  • Privacy-first design

๐Ÿš€ Deployment

GitHub Pages (Recommended)

  1. Set up repository secrets:

    • Go to repository Settings > Secrets and variables > Actions
    • Add OPENAI_API_KEY with your OpenAI API key
    • Add other production environment variables as needed
  2. Enable GitHub Pages:

    • Go to repository Settings > Pages
    • Set source to "GitHub Actions"
  3. Push to main branch:

    git push origin main

The site will automatically deploy via GitHub Actions.

Custom Deployment

Build the project and deploy the dist folder to any static hosting service:

npm run build
# Upload the 'dist' folder to your hosting provider

๐Ÿค Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

๐Ÿ“ License

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

๐Ÿ†˜ Support

  • Issues: Report bugs and request features via GitHub Issues
  • Documentation: Check this README and inline code comments
  • Community: Join discussions in the repository

๐Ÿ”ฎ Roadmap

  • Real-time collaboration features
  • Voice chat integration
  • Plugin system for custom tools
  • Advanced analytics dashboard
  • Mobile app companion
  • Enterprise authentication (SSO)
  • Custom AI model fine-tuning
  • API for third-party integrations

Built with โค๏ธ by the PumaAI team

About

Your platform for AI.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •