Edunet Portal

Edunet Portal is a Java-based educational platform for managing student and professor data, student engagement, and course-related queries.

Table of Contents

1. Project Overview
2. Features
3. Getting Started
   • Prerequisites
   • Installation
4. Usage
5. Contributing
6. Code of Conduct
7. License

Project Overview

Edunet Portal is a comprehensive educational platform designed to facilitate the management of students, professors, and course-related data. It offers features for generating student transcripts, managing student engagement, and handling course-related queries.

Features

• Student Transcripts: Generate and save student transcripts as PDF documents.
• Student Engagement: View and manage student engagement data for professors.
• Course Queries: Handle queries related to courses, including resolutions.

Getting Started

Prerequisites

Before you start, ensure you have the following prerequisites:

• Java Development Kit (JDK)
• Apache PDFBox library (for transcript generation)

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/edunet-portal.git
   

Opening the Project

1. Open the project in your Java development environment (e.g., NetBeans).

Setting up Libraries

2. Configure the required libraries and dependencies in your project environment.

Usage

User Roles

• Edunet Portal supports different user roles, including students and professors. Ensure you have appropriate user accounts to access the features.

Transcript Generation

• Generate Transcripts: Create and save student transcripts in PDF format.

• Transcript Layout: Transcripts include student information, completed courses, and relevant details.

• Image Handling: The system can handle student images, and a default image is provided if none is available.

Student Engagement

• Professor's View: Professors can view and manage student engagement data.

• Student Engagement Data: This feature allows professors to track student participation and engagement.

Course Queries

• Course Queries: Manage queries related to courses, including resolutions.

• Resolution Submission: Professors can submit resolutions for course-related queries.

Contributing

We welcome contributions from the community to improve and enhance the Edunet Portal project. Here's how you can contribute:

1. Fork the Project: Fork the project and create a new branch for your feature or bug fix.

2. Make Changes: Implement your changes and ensure that the code follows the established coding conventions.

3. Testing: Thoroughly test your changes to avoid introducing bugs.

4. Create a Pull Request (PR): Submit a PR with a clear description of your changes.

Code of Conduct

Please note that we have a Code of Conduct that we expect all contributors to follow.

License

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

Naming Conventions

We follow specific naming conventions to maintain code consistency. Here are the naming conventions:

Branch Naming

• Feature Branches: feature/descriptive-feature-name
• Bug Fix Branches: bugfix/issue-description
• Hotfix Branches: hotfix/descriptive-fix-name
• Release Branches: release/version-number
• Main/Branches: main or master
• Development Branches: development
• Personal Branches: username/descriptive-branch-name

Function Naming

• Use camelCase for function names (e.g., generateTranscript).

Variable Naming

• Use camelCase for variable names (e.g., studentName).

Package Naming

• Use lowercase and follow a meaningful package structure (e.g., ui.professor).

Show Your Support

If you find Edunet Portal helpful, please consider giving it a star ⭐ on GitHub. Your support is greatly appreciated!