Weekly Message Generator for Teachers

Overview

The Weekly Message Generator is a specialized React application designed to help educators quickly create comprehensive weekly reports for parents or guardians. Built with Next.js and tailored for Arabic-language educational settings, this tool streamlines the process of documenting class activities, student attendance, and homework assignments.

🌟 Key Features

1. Dynamic Class Information

• Input and save your class name
• Select and format dates (both Gregorian and Hijri calendars)

2. Student Management

• Add and remove students dynamically
• Track attendance with precision
• Record late arrivals

3. Flexible Homework Tracking

• General homework for all students
• Specific assignments for individual students
• Toggle homework sections on/off

4. Customizable Reporting Sections

• Study Progress
• Teacher Notes
• Reminders
• Custom Sections

5. Instant Message Generation

• One-click message generation
• Easy clipboard copying
• Clean, professional formatting in Arabic

🚀 Technologies Used

• React
• Next.js
• Tailwind CSS
• Lucide Icons
• Local Storage for persistent data

📋 Prerequisites

• Node.js (v16 or later)
• npm or yarn
• Basic understanding of React and Next.js

🔧 Installation

1. Clone the repository:

   git clone https://github.com/hazemelraffiee/weekly-message-generator.git

2. Navigate to the project directory:

   cd weekly-message-generator

3. Install dependencies:

   npm install
   # or
   yarn install

🖥️ Running the Application

Start the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 in your browser.

📝 Usage Guide

1. Enter your class name
2. Select the report date
3. Add students to your roster
4. Mark attendance
5. Add homework (general or specific)
6. Include additional notes or reminders
7. Click "Copy Message" to generate a formatted report

🌐 Localization

The application is specifically designed for Arabic-language educational environments, with:

• Right-to-left (RTL) text support
• Dual date formatting (Gregorian and Hijri)
• Arabic interface and messaging

🔒 Data Persistence

• Uses browser's Local Storage to save:
  • Class information
  • Student roster
  • Attendance records
  • Homework assignments
• Data persists between sessions

🤝 Contributing

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

📄 License

Distributed under the MIT License. See LICENSE for more information.

📞 Contact

Your Name - your.email@example.com

Project Link: https://github.com/hazemelraffiee/weekly-message-generator

🙏 Acknowledgements

• Next.js
• React
• Tailwind CSS
• Lucide Icons