- Overview
- Key Features
- Tech Stack
- Architecture
- Getting Started
- AI Capabilities
- API Endpoints
- Payment Integration
- Deployment
- Contributing
- License
- Support
QUICKGPT is a comprehensive AI content generation platform that provides:
- 💬 AI Chat Assistant: Intelligent conversations with GPT models
- 🎨 AI Image Generation: Create stunning visuals from text prompts
- 📝 Content Creation: Generate articles, blogs, and creative text
- 👥 Community Features: Share and discover AI creations
- 💳 Credit System: Flexible pricing with Stripe integration
- 🔐 User Management: Secure authentication and profile management
Built with the MERN stack and integrated with OpenAI's powerful AI models for text and image generation.
- Text Generation: GPT-4 powered content creation
- Image Generation: DALL-E integration for visual content
- Chat Interface: Conversational AI assistant
- Multiple Models: Support for various AI models and parameters
- Flexible Pricing: Pay-per-use credit system
- Stripe Integration: Secure payment processing
- Credit Management: Track usage and purchase history
- Free Tier: Limited free credits for new users
- Secure Authentication: JWT-based user management
- Profile Management: Personalize your AI experience
- Creation History: Save and manage generated content
- Community Sharing: Share creations with other users
- ImageKit Integration: Optimized image storage and delivery
- Fast CDN: Quick loading times for generated images
- Image Optimization: Automatic compression and formatting
- Secure Uploads: Protected file storage
- React 19 - Latest React with concurrent features
- Vite - Next-generation build tool
- Tailwind CSS - Utility-first CSS framework
- Axios - HTTP client for API calls
- React Router DOM - Client-side routing
- React Hot Toast - User notifications
- React Markdown - Markdown rendering
- Moment.js - Date formatting and manipulation
- Node.js - JavaScript runtime environment
- Express 5 - Web application framework
- MongoDB - NoSQL database for flexible data storage
- OpenAI API - GPT and DALL-E integration
- ImageKit - Image optimization and CDN
- Stripe - Payment processing
- Bcrypt - Password hashing
- CORS - Cross-origin resource sharing
- JSON Web Tokens - Authentication
- Vercel - Frontend deployment platform
- Render/Railway - Backend deployment
- MongoDB Atlas - Cloud database service
- ImageKit CDN - Media content delivery
QuickGPT/
├── client/ # React Frontend
│ ├── src/
│ │ ├── assets/ # Static assets
│ │ ├── components/ # Reusable components
│ │ │ ├── ChatBoot.jsx # AI chat interface
│ │ │ ├── Message.jsx # Message component
│ │ │ ├── Sidebar.jsx # Navigation sidebar
│ │ │ └── ...
│ │ ├── context/ # React context
│ │ │ └── AppContext.jsx # Global state management
│ │ ├── pages/ # Route pages
│ │ │ ├── Community.jsx # Community creations
│ │ │ ├── Credits.jsx # Credit management
│ │ │ ├── LoadImg.jsx # Image generation
│ │ │ ├── Login.jsx # Authentication
│ │ │ └── App.jsx # Main app component
│ │ ├── index.css # Global styles
│ │ └── main.jsx # Application entry point
│ ├── package.json # Dependencies and scripts
│ └── vite.config.js # Vite configuration
│
├── server/ # Express Backend
│ ├── config/ # Configuration files
│ ├── controllers/ # Business logic
│ ├── middleware/ # Custom middlewares
│ ├── models/ # Database models
│ ├── routes/ # API routes
│ ├── package.json # Dependencies and scripts
│ └── server.js # Server entry point
└── LICENSE # Project license- Node.js (v18 or higher)
- npm (v8 or higher)
- MongoDB Atlas account or local MongoDB
- OpenAI API account
- ImageKit account
- Stripe account (for payments)
- Clone the repository:
git clone https://github.com/elyse502/QuickGPT.git
cd QuickGPT- Install client dependencies:
cd client && npm install- Install server dependencies:
cd ../server && npm installClient (.env)
VITE_API_BASE_URL=http://localhost:5000
VITE_IMAGEKIT_URL_ENDPOINT=your-imagekit-endpoint
VITE_IMAGEKIT_PUBLIC_KEY=your-imagekit-public-key
VITE_STRIPE_PUBLISHABLE_KEY=pk_test_...Server (.env)
MONGODB_URI=your-mongodb-connection-string
OPENAI_API_KEY=sk-your-openai-key
IMAGEKIT_PRIVATE_KEY=your-imagekit-private-key
STRIPE_SECRET_KEY=sk_test_...
JWT_SECRET=your-jwt-secret-key
PORT=5000- Start the development servers:
# Terminal 1 - Start backend
cd server && npm run server
# Terminal 2 - Start frontend
cd client && npm run dev- GPT-4 Integration: State-of-the-art language model
- Content Types: Articles, blogs, stories, code, etc.
- Custom Parameters: Temperature, max tokens, creativity control
- Conversational AI: Context-aware chat interactions
- DALL-E Integration: Advanced image generation
- Multiple Styles: Various artistic styles and formats
- Resolution Options: Different size and quality settings
- Prompt Optimization: AI-assisted prompt improvement
- Streaming Responses: Real-time text generation
- Progress Indicators: Generation status updates
- Error Handling: Graceful failure recovery
- Rate Limiting: Fair usage policies
| Method | Endpoint | Description |
|---|---|---|
| POST | /register |
User registration |
| POST | /login |
User login |
| GET | /profile |
Get user profile |
| PUT | /profile |
Update user profile |
| Method | Endpoint | Description |
|---|---|---|
| POST | /generate-text |
Generate text content |
| POST | /generate-image |
Generate images from text |
| POST | /chat |
Conversational AI chat |
| GET | /models |
Get available AI models |
| Method | Endpoint | Description |
|---|---|---|
| GET | /balance |
Get user credit balance |
| POST | /purchase |
Purchase credits via Stripe |
| GET | /history |
Get credit usage history |
| Method | Endpoint | Description |
|---|---|---|
| GET | /creations |
Get community creations |
| POST | /share |
Share a creation |
| GET | /creations/:id |
Get specific creation |
- Create a Stripe account
- Get API keys from Stripe dashboard
- Configure webhooks for payment events
- Set up products and pricing in Stripe
- Free Tier: 10 free credits on signup
- Credit Packages: Various pricing options
- Usage Tracking: Real-time credit deduction
- Purchase History: Complete transaction records
- Payment Success: Credit balance update
- Payment Failure: Graceful error handling
- Subscription Support: Recurring payments
- Refund Processing: Credit reversal
Deploy with environment variables configured for:
- MongoDB Atlas connection
- OpenAI API integration
- ImageKit configuration
- Stripe payment processing
# Recommended: MongoDB Atlas Cloud
https://www.mongodb.com/atlas# Production environment variables
MONGODB_URI=your-production-mongodb-uri
OPENAI_API_KEY=your-production-openai-key
STRIPE_SECRET_KEY=your-production-stripe-key- ⚡ Fast Loading: Vite-optimized build process
- 🎯 AI Response Time: Optimized API calls
- 📱 Mobile Responsive: Tailwind CSS mobile-first design
- 🔒 Security: JWT authentication and input validation
- 💾 Efficient Storage: MongoDB optimized queries
We welcome contributions! Please follow these steps:
- Fork the repository
- Create a feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
- Follow React best practices
- Use meaningful commit messages
- Write comprehensive tests
- Update documentation accordingly
Distributed under the ISC License. See LICENSE for more information.
For support, email [email protected] or create an issue in the GitHub repository.
For any questions or support, please contact:
- NIYIBIZI Elysée👨🏿💻 | Github | Linkedin | Twitter.
- Email: [email protected]
QUICKGPT - Unleash your creativity with AI! 🚀
Built with ❤️ using the MERN stack and cutting-edge AI technologies.
Made with ❤️ by Elysée NIYIBIZI