Skip to content

README.md

Latest commit

 

History

History
318 lines (243 loc) · 8.27 KB

README.md

File metadata and controls

318 lines (243 loc) · 8.27 KB
Raw

AI-Powered ECE Project Generator

A complete web-based system for generating professional ECE (Electronics and Communication Engineering) mini and major projects with full reports using AI.

🎯 Features

✅ Complete Project Generation - All required sections automatically generated
✅ Dynamic Student Inputs - Semester, Skill Level, Interest Area, Budget, Project Type
✅ Exam-Ready Output - Suitable for college submission, viva, and hackathons
✅ Realistic Components - Indian market-based components with actual INR costs
✅ Modern Technologies - IoT, Robotics, AI, Embedded Systems, Signal Processing
✅ Export Options - Copy, Download, Print functionality
✅ Responsive Design - Works on desktop and tablet

📋 Generated Report Sections

The system generates a complete report with 14 mandatory sections:

  1. Project Title - Compelling, specific project name
  2. Problem Definition - Real-world problem explanation
  3. Working Logic - Step-by-step operation (8-10 steps minimum)
  4. Components Required
    • Hardware Components (Name, Purpose, Specification)
    • Software/Tools Used
  5. Estimated Cost - Component-wise breakdown in INR
  6. Future Scope - 5+ improvements and extensions
  7. Complete Project Report
    • 7.1 Abstract (150-200 words)
    • 7.2 Introduction (250-300 words)
    • 7.3 Problem Statement
    • 7.4 Proposed System
    • 7.5 Working Methodology
    • 7.6 Hardware Description
    • 7.7 Software Description
    • 7.8 Block Diagram Explanation
    • 7.9 Expected Output
    • 7.10 Advantages
    • 7.11 Applications
    • 7.12 Limitations
    • 7.13 Future Enhancements
    • 7.14 Conclusion

🚀 Setup Instructions

Prerequisites

  • Modern web browser (Chrome, Firefox, Edge, Safari)
  • OpenAI API key (GPT-4 access)
  • Internet connection

Step 1: Get OpenAI API Key

  1. Visit OpenAI Platform
  2. Sign up or log in to your account
  3. Navigate to API Keys section
  4. Click Create new secret key
  5. Copy the key (format: sk-...)
  6. Save it securely - you'll need it in the application

Step 2: Open the Application

  1. Navigate to the project folder
  2. Open index.html in your web browser
  3. Or use a local server (recommended): 
    # Python 3
python -m http.server 8000

# Or Python 2
python -m SimpleHTTPServer 8000

# Or Node.js
npx http-server
    Then open http://localhost:8000

Step 3: Fill the Form

  1. Semester: Select your current semester (3-8)
  2. Skill Level: Choose Beginner, Intermediate, or Advanced
  3. Interest Area: Pick from 10+ technical areas
  4. Budget: Select budget range in INR
  5. Project Type: Choose Mini, Major, Hackathon, or Research
  6. API Key: Paste your OpenAI API key (stored locally only)

Step 4: Generate Project

  1. Click "Generate Project" button
  2. Wait 30-60 seconds for AI to generate complete report
  3. Review the generated content
  4. Use Copy, Download, or Print options

📁 Project Structure

ece-project-generator/
├── index.html              # Main web interface
├── styles.css              # Styling and responsive design
├── script.js               # JavaScript logic and AI integration
├── prompts/
│   └── master_prompt.txt   # Master prompt template
├── output/                 # Generated reports (optional)
└── README.md              # This file

🔧 File Descriptions

index.html

  • Form for student inputs
  • Output panel for displaying generated reports
  • Buttons for Copy, Download, Print
  • Responsive layout for all devices

styles.css

  • Beautiful gradient design (Purple theme)
  • Responsive grid layout
  • Form styling with interactive effects
  • Report formatting
  • Custom scrollbars
  • Print-friendly styles

script.js

  • Form validation
  • OpenAI API integration
  • Prompt template replacement
  • Report formatting and display
  • Export functionality (copy, download, print)
  • Local storage for API key (optional)

prompts/master_prompt.txt

  • Complete master prompt template
  • Placeholder variables: {SEMESTER}, {SKILL_LEVEL}, etc.
  • Detailed section requirements
  • Quality constraints
  • 14 mandatory report sections

💡 How It Works

  1. Input Collection: Form captures student information
  2. Prompt Generation: Master prompt is customized with student inputs
  3. AI Processing: OpenAI GPT-4 generates complete project report
  4. Output Formatting: Report is parsed and displayed beautifully
  5. Export Options: User can copy, download, or print the report

🎓 Interest Areas Supported

  • IoT and Smart Systems
  • Robotics
  • Signal Processing
  • Power Electronics
  • Communication Systems
  • Embedded Systems
  • VLSI and Microelectronics
  • Machine Learning and AI
  • Wireless Networks
  • Control Systems

💰 Budget Options

  • ₹5,000 - Basic (Microcontroller-based)
  • ₹10,000 - Standard (Arduino/Raspberry Pi)
  • ₹15,000 - Good (Advanced sensors)
  • ₹25,000 - Professional (FPGA/DSP boards)
  • ₹50,000+ - Advanced (Industrial components)

🔐 Security & Privacy

  • API Key: Stored locally in browser (localStorage)
  • No Server Storage: All processing is client-side
  • No Data Transmission: Only communicates with OpenAI API
  • HTTPS Recommended: Use HTTPS when deploying

⚙️ Configuration

Modify Master Prompt

Edit prompts/master_prompt.txt to customize:

  • Output format
  • Required sections
  • Content guidelines
  • Quality standards

Add More Interest Areas

Edit script.js - Find the select element with id interestArea:

<option value="Your New Area">Your New Area</option>

Change AI Model

In script.js, modify the model name in the fetch call:

model: 'gpt-3.5-turbo',  // Change this

Available models:

  • gpt-4-turbo (Recommended - Most capable)
  • gpt-4
  • gpt-3.5-turbo (Faster, cheaper)

📊 Sample Projects Generated

The system can generate projects like:

  • IoT Home Automation System (Beginner, 5000)
  • Gesture-Controlled Robot (Intermediate, 15000)
  • Real-time ECG Monitor (Advanced, 25000)
  • AI-based Traffic Management (Advanced, 50000)
  • Smart Energy Management System (Intermediate, 10000)

⚠️ Limitations

  • Requires valid OpenAI API key with GPT-4 access
  • Generation takes 30-60 seconds (OpenAI processing time)
  • Internet connection required
  • API charges apply per request (~$0.05-0.15 per project)

🐛 Troubleshooting

API Key Error

Error: "Invalid API Key"
Solution:

  • Verify key format starts with sk-
  • Ensure key is active on OpenAI dashboard
  • Check account has API credits

Timeout Error

Error: "Request timed out"
Solution:

  • Check internet connection
  • OpenAI servers might be busy - try again later
  • Increase timeout in script (modify fetch timeout)

Blank Output

Error: No report displayed
Solution:

  • Check browser console for errors (F12)
  • Verify API key is correct
  • Ensure full form is filled
  • Try with GPT-3.5-turbo model

🚢 Deployment

Deploy on GitHub Pages

  1. Push code to GitHub repository
  2. Enable Pages in repository settings
  3. Access via: https://username.github.io/repo-name

Deploy on Vercel

npm install -g vercel
vercel

Deploy on Netlify

  1. Connect GitHub repository
  2. Build command: (none - it's static)
  3. Publish directory: .

📚 API Documentation

OpenAI Integration

POST https://api.openai.com/v1/chat/completions
Headers:
  - Authorization: Bearer {API_KEY}
  - Content-Type: application/json

Body:
  {
    "model": "gpt-4-turbo",
    "messages": [...],
    "temperature": 0.7,
    "max_tokens": 4000
  }

📝 License

This project is open-source and free to use for educational purposes.

👨‍🎓 Designed For

  • ECE Students (3rd - 8th Semester)
  • Project Submission
  • Viva Preparation
  • Hackathon Participation
  • Technical Interviews
  • Academic Excellence

🤝 Contributing

Contributions welcome! Feel free to:

  • Add more interest areas
  • Improve prompt templates
  • Enhance UI/UX
  • Fix bugs

📧 Support

For issues or questions:

  1. Check Troubleshooting section
  2. Review master_prompt.txt for customization
  3. Verify API key and account status

🎉 Version

v1.0 - Initial Release (January 2026)

Made with ❤️ for ECE Students 🎓