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.
- ๐ค 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
- 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
- Node.js 18+ and npm
- OpenAI API key (for full AI functionality)
-
Clone the repository
git clone https://github.com/PumaAI-v2/homepage.git cd homepage/homepage -
Install dependencies
npm install
-
Set up environment variables
cp .env.example .env
Edit
.envand 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
-
Start development server
npm run dev
-
Open in browser Navigate to
http://localhost:5173
npm run build
npm run preview # Preview the production build locallynpm run deployCreate 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-
OpenAI API Key:
- Go to OpenAI Platform
- Create a new API key
- Add it to your
.envfile asVITE_OPENAI_API_KEY
-
Google Analytics (Optional):
- Set up a Google Analytics 4 property
- Add the Measurement ID to
VITE_GOOGLE_ANALYTICS_ID
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
- Real-time chat with OpenAI GPT
- Multiple conversation threads
- Quick action buttons for common prompts
- Message history and context awareness
- User profile management
- API key configuration
- Theme and display preferences
- Notification settings
- Chat activity tracking
- API usage monitoring
- Response time analytics
- Cost tracking (when applicable)
- Choose between GPT models
- Temperature and parameter controls
- Custom system prompts
- Data retention controls
- Export conversation history
- Delete account functionality
- Privacy-first design
-
Set up repository secrets:
- Go to repository Settings > Secrets and variables > Actions
- Add
OPENAI_API_KEYwith your OpenAI API key - Add other production environment variables as needed
-
Enable GitHub Pages:
- Go to repository Settings > Pages
- Set source to "GitHub Actions"
-
Push to main branch:
git push origin main
The site will automatically deploy via GitHub Actions.
Build the project and deploy the dist folder to any static hosting service:
npm run build
# Upload the 'dist' folder to your hosting provider- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
- Issues: Report bugs and request features via GitHub Issues
- Documentation: Check this README and inline code comments
- Community: Join discussions in the repository
- 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