β¨ Empower Your Workflow with AI β Summarize, Generate, Chat, Code, Imagine, and More in One Seamless Platform!
VedVaani is a modern, responsive, and feature-packed AI-powered web application built with the MERN stack and styled with Material-UI. It combines text summarization, content generation, interactive chatbot capabilities, JavaScript code conversion, sci-fi image generation, & new cutting-edge features like real-time collaboration, voice input, and AI-driven analytics. Designed for productivity enthusiasts, developers, and creatives, VedVaani offers an intuitive interface to harness AIβs potential.
πΉ π§Ύ Text Summarizer β Condense lengthy articles or documents into concise, meaningful summaries.
πΉ π Paragraph Generator β Generate coherent, context-aware paragraphs for blogs, essays, or reports.
πΉ π€ AI Chatbot β Engage in real-time conversations with an AI assistant powered by OpenAIβs GPT models.
πΉ π» JS Code Converter β Transform JavaScript code (e.g., ES5 to ES6) or generate code snippets from natural language prompts.
πΉ πͺ Sci-Fi Image Generator β Create stunning sci-fi visuals using OpenAIβs DALLΒ·E or Stable Diffusion APIs.
Experience a responsive, Material-UI-powered interface optimized for desktop and mobile:
vedvaani/
βββ frontend/ # React frontend
β βββ src/
β β βββ components/ # Reusable UI components (e.g., ChatBox, SummaryCard)
β β βββ pages/ # Feature pages (Home, ChatBot, Summarizer, etc.)
β β βββ assets/ # Images, icons, and static files
β β βββ context/ # React Context for state management (e.g., theme, auth)
β β βββ App.js # App routing and layout
β β βββ index.js # App entry point
βββ backend/ # Node.js/Express backend
β βββ routes/ # API routes (e.g., /api/v1/openai/chatbot)
β βββ controllers/ # Request handlers for AI features
β βββ models/ # MongoDB schemas (e.g., User, Analytics)
β βββ config/ # Environment variables and OpenAI API setup
β βββ server.js # Express server entry point
βββ .env # Environment variables (e.g., OPENAI_API_KEY)
βββ package.json # Project dependencies and scripts
βββ README.md # Project documentation
Follow these steps to set up VedVaani locally:
- Node.js (v16 or higher)
- MongoDB (local or MongoDB Atlas)
- OpenAI API Key (sign up at platform.openai.com)
- Git installed
-
Clone the Repository:
git clone https://github.com/yourusername/vedvaani.git cd vedvaani -
Set Up the Backend:
- Navigate to the backend folder:
cd backend npm install - Create a
.envfile inbackend/with:PORT=3001 MONGODB_URI=mongodb://localhost:27017/vedvaani OPENAI_API_KEY=your_openai_api_key JWT_SECRET=your_jwt_secret - Start the backend server:
npm start
- Navigate to the backend folder:
-
Set Up the Frontend:
- Navigate to the frontend folder:
cd ../frontend npm install - Create a
.envfile infrontend/with:REACT_APP_API_URL=http://localhost:3001/api/v1 - Start the frontend:
npm start
- Navigate to the frontend folder:
-
Access the App:
- Open
http://localhost:3000in your browser. - Ensure the backend is running on
http://localhost:3001.
- Open
- βοΈ React: Component-based UI library for dynamic interfaces.
- π¨ Material-UI (MUI): Pre-built, customizable components for a polished look and feel.
- π React Router: Handles client-side routing for seamless navigation.
- π‘ Axios: Makes HTTP requests to the backend API.
- π£οΈ Web Speech API: Enables voice input for chatbot and text fields.
- ποΈ Redux Toolkit (optional): Manages global state for complex features like collaboration.
- π Chart.js: Visualizes AI usage analytics in the dashboard.
- π’ Node.js: Runtime for the server-side application.
- π Express.js: Web framework for building RESTful APIs.
- π MongoDB: NoSQL database for storing user data, analytics, and session history.
- π§ OpenAI API: Powers text summarization, generation, chatbot, and image creation.
- π JWT: Secures API endpoints with user authentication.
- π‘ Socket.IO: Enables real-time collaboration and live chat features.
- π Multer: Handles file uploads for image generation inputs.
- π Vercel: Frontend deployment for fast, scalable hosting.
- βοΈ Render: Backend deployment with MongoDB integration.
- π§ GitHub Actions: CI/CD pipeline for automated testing and deployment.
- Backend Endpoint: Ensure
/api/v1/openai/chatbotand other routes are accessible. - CORS Configuration: The backend includes CORS middleware to allow requests from
http://localhost:3000. - Error Handling:
- 404 Errors: Verify the route exists in
backend/routes/. - 401 Errors: Check the
OPENAI_API_KEYin.env. - 500 Errors: Ensure MongoDB is running and connected.
- 404 Errors: Verify the route exists in
Example API call (chatbot):
axios.post('http://localhost:3001/api/v1/openai/chatbot', {
prompt: 'Hello, how can you assist me today?'
}).then(response => console.log(response.data));-
ποΈ Voice-Enabled Chatbot:
-
π€ Real-Time Collaboration:
- Integrated Socket.IO for live text and code editing.
- Teams can work on summaries, paragraphs, or JS code together, with real-time updates.
-
π AI Usage Dashboard:
- A MongoDB-backed dashboard tracks API usage (e.g., number of summaries, chatbot messages).
- Visualized with Chart.js for insights into user behavior.
-
π Dark Mode & Theme Customization:
- Toggle between light, dark, and custom themes using Material-UIβs theme provider.
- Persists user preferences in MongoDB.
-
π Offline Support:
- Uses service workers to cache recent AI responses, allowing limited functionality offline.
- Ideal for users with unstable internet connections.
-
π User Authentication:
- Implemented JWT-based authentication for secure access.
- Users can save their work (e.g., summaries, generated images) to their accounts.
-
π§ Advanced AI Models:
-
π± PWA Support:
- Progressive Web App features allow installation on mobile devices.
- Offline caching and push notifications for new AI features.
- Linting & Formatting: ESLint and Prettier for code consistency.
- Testing:
- Frontend: Jest and React Testing Library for component tests.
- Backend: Mocha and Chai for API endpoint tests.
- CI/CD: GitHub Actions for automated testing and deployment to Vercel/Render.
-
Frontend (Vercel):
- Push the
frontend/folder to a GitHub repository. - Connect to Vercel, set
REACT_APP_API_URLin environment variables. - Deploy with
vercel --prod.
- Push the
-
Backend (Render):
- Push the
backend/folder to a separate repository. - Configure MongoDB Atlas and environment variables on Render.
- Deploy with Renderβs Node.js service.
- Push the
π Licensed under the MIT License. Feel free to fork, modify, and share!
- π Multilingual Support: Add translation features for non-English inputs using OpenAIβs models.
- π€ Custom AI Assistants: Allow users to create tailored chatbot personas.
- π€ Export Options: Save summaries or images as PDF/PNG files.
- β‘ Performance Optimization: Implement server-side rendering (Next.js) for faster load times.
- π API Integrations: Add support for other AI providers (e.g., Anthropic, Google Gemini).
We welcome contributions! To get started:
- Fork the repository.
- Create a feature branch (
git checkout -b feature/amazing-feature). - Commit changes (
git commit -m 'Add amazing feature'). - Push to the branch (
git push origin feature/amazing-feature). - Open a Pull Request.
See CONTRIBUTING.md for details.
- GitHub: yourusername
- Email: rathodsachin0766@gmail.com
- Discord: Join our community VedVaani Discord
π― βAI is your co-pilot β let VedVaani steer your productivity to new heights!β
- React: Powers the dynamic, component-based UI. Components like
ChatBox,SummaryCard, andImageGeneratorare reusable and modular. - Material-UI: Provides a consistent design system with components like
TextField,Button, andThemeProviderfor theming. - Axios: Handles API requests to the backend for all AI features.
- React Router: Manages navigation between pages (e.g.,
/chatbot,/summarizer). - Web Speech API: Adds voice input/output, making the app accessible.
- Chart.js: Renders interactive charts in the AI usage dashboard.
- PWA: Enabled via
workboxfor offline support and mobile installation.
- Node.js/Express: Runs the server and defines API routes (e.g.,
/api/v1/openai/chatbot,/api/v1/openai/summarize). - MongoDB: Stores user data, session history, and analytics (e.g., schemas for
User,Analytics,ChatHistory). - OpenAI API: Integrates GPT-4o for text-based features and DALLΒ·E 3 for image generation.
- Socket.IO: Facilitates real-time collaboration and live updates.
- JWT: Authenticates users for secure access to features.
- Multer: Processes file uploads for image generation prompts.
