Transforming Education Through Data-Driven Insights

InsightEd is a modern web application designed to help teachers track, analyze, and improve student performance through data-driven insights. Built with React and TypeScript, it offers a seamless experience for managing student data, analyzing performance trends, and generating comprehensive reports.

• Real-time class performance dashboards
• Subject-wise analysis with detailed metrics
• Performance trend visualization
• Comparative analysis tools

• Comprehensive student profiles
• Exam score tracking
• Performance history
• Parent contact management

• Easy exam score entry
• Multiple subject support
• Score analysis and trends
• Performance categorization

• Automated PDF report generation
• Customizable report templates
• Individual student reports
• Class performance summaries

• Framework: React 18.3.1
• Language: TypeScript 5.5.3
• Build Tool: Vite 5.4.1
• Styling: TailwindCSS 3.4.11
• UI Components: shadcn/ui
• Charts: Recharts
• PDF Generation: jsPDF

• ESLint for code quality
• Prettier for code formatting
• PostCSS for CSS processing
• TypeScript for type safety

1. Clone the repository:

git clone https://github.com/your-username/InsightEd.git

2. Install dependencies:

cd InsightEd
npm install

3. Start the development server:

npm run dev

4. Build for production:

npm run build

1. Environment Variables:

VITE_APP_TITLE=InsightEd
VITE_APP_API_URL=your-api-url

2. Tailwind Configuration:

• Custom theme settings in tailwind.config.ts
• Additional styling in src/index.css

Comprehensive documentation is available in the docs directory:

• System Overview - Architecture and components
• Component Interactions - Component communication
• Data Model - Data structures and relationships
• User Flows - User journey documentation
• UI Components - UI component structure
• Future Roadmap - Planned enhancements

All documentation includes detailed Mermaid diagrams for visual representation.

Run tests with:

npm run test

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

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

• shadcn/ui for beautiful UI components
• Recharts for data visualization
• jsPDF for PDF generation
• TailwindCSS for styling

See our Future Roadmap for planned features and enhancements.

For support, please open an issue in the GitHub repository or contact the maintainers.

Built with ❤️ for improving education through technology