Welcome to the Hutech Classroom Client App repository! This is a React-based application that serves as the frontend for the Hutech Classroom platform. It utilizes MobX for state management and MUI (Material-UI) for UI components.
- Overview
- Getting Started
- Features
- Built with
- Web API
- Web Administration
- User Web Interface
- Source Code
- Contributing
- Contributors
- License
The HUTECH CLASSROOM project is a Classroom Management System designed for HUTECH University. Its purpose is to improve the management of classrooms, create favorable conditions for students, and support teachers and the university in monitoring and managing information.
This is a product developed for the specialized projects at HUTECH University. The aim of this project is to assist teachers or staff members at the university in a more efficient classroom management process for students. This project is not intended for commercial purposes.
We are a group of students at HUTECH University. This project is a part of our learning process, and we hope it can be of benefit to HUTECH University in particular, and other universities in general.
If you are interested or have suggestions for this project, please contact the contributors on this project!
To get started with the Hutech Classroom Client App, follow the installation instructions outlined below:
- Clone this repository:
git clone https://github.com/MeiCloudie/hutech-classroom-client-app.git- Navigate to the project directory:
cd hutech-classroom-client-app- Install dependencies:
npm install- Set up environment variables:
- Create a
.envfile at the root of the project - Provide the required environment variables (refer to
.env.example)
- Start the development server:
npm start- Access the app at
http://localhost:3000
-
User Authentication and Role-Based Access Control:
- Secure login for students, staff, course coordinators, department heads, educational staff, and administrators.
- Role-based access control to ensure users only access relevant features and data.
-
Student and Staff Information Management:
- Input and management of student and staff information, including basic details and roles.
-
Department and Major Management:
- Creation and management of department and major information.
-
Course Management:
- Input and management of course details, credit hours, contact hours, knowledge volume, and more.
-
Class Management:
- Organizing classes by semester, generating class codes, and managing class details.
-
Assignment, Project, and Task Management:
- Creation and management of assignments, projects (including group projects), and tasks.
- Submission of solutions by students with support for multiple versions.
-
Discussion Forum:
- A platform for students to create posts, comment, and engage in academic discussions.
-
Messaging:
- Direct messaging feature for private communication and collaboration among students.
-
Web and Mobile Accessibility:
- Accessible via both website and mobile app for flexibility.
-
User-Friendly Interfaces:
- User-friendly interfaces with intuitive navigation for an enhanced user experience.
-
Data Management:
- Efficient organization and access to class information, assignments, projects, tasks, and user data.
-
Notifications:
- Notification system to alert users about important updates, deadlines, and messages.
-
Data Privacy and Security:
- Prioritizing data privacy and security to protect user and academic data.
-
Scalability:
- Design to accommodate future growth in users, courses, and data volume.
-
Maintenance and Support:
- Provisions for ongoing system maintenance and user support.
-
Documentation and Training:
- Comprehensive documentation and training materials for users and administrators.
-
Feedback Mechanism:
- Mechanism for users to provide feedback, report issues, and suggest improvements.
-
Compliance:
- Compliance with relevant laws and regulations related to data privacy, accessibility, and educational standards.
-
Integration:
- Support for integration with other university systems and tools.
-
Reporting and Analytics:
- Reporting and analytics capabilities to generate insights into student performance and system usage.
-
Backup and Recovery:
- Regular data backups and recovery plan to prevent data loss and downtime.
-
User Support:
- Channels for user support to address questions, issues, and technical difficulties.
-
Usability Testing:
- Conducting usability testing with students and staff to ensure user-friendliness.
-
Continuous Improvement:
- Establishing a process for continuous system improvement based on user feedback.
-
Scalable Architecture and Interoperability:
- Scalable system architecture and interoperability with other university systems.
-
Security Measures:
- Robust security measures, including data encryption and access controls.
-
Accessibility:
- Ensuring the system is accessible to users with disabilities.
And a few other functions for this project are in development!
The Hutech Classroom Client App is built with the following technologies:
- React - A JavaScript library for building user interfaces
- MobX - A state management library for React applications
- MUI (Material-UI) - A popular React UI framework based on Material Design principles
The Web API serves as the backend for the HUTECH Classroom system. It handles various requests and provides the necessary functionalities. You can explore the Web API by visiting the following URL: Web API
⚠ You can watch it because this project is still a work in progress, not yet in use!
The Web Administration is the administrative web interface for the HUTECH Classroom system. It allows administrators to manage classrooms, users, and perform other administrative tasks. You can access the Web Administration interface at: Web Administration
⚠ You can watch it because this project is still a work in progress, not yet in use!
The User Web Interface is the user-facing web interface for the HUTECH Classroom system. It enables users to access classrooms, interact with course materials, submit assignments, and engage in online discussions. You can access the User Web Interface at: User Web Interface
▶ In the future we will develop on mobile!
The source code for the HUTECH Classroom project is publicly available on GitHub.
⚠ You can watch it because this project is still a work in progress, not yet in use!
The backend source code repository can be found at: Backend Source Code
The frontend source code repository can be found at: Frontend Source Code
The flutter source code repository can be found at: Flutter Source Code
Please contact us if you would like to contribute to this project!
Contributions to the Hutech Classroom Client App are welcome! If you find any bugs, issues, or have suggestions for improvements, please open an issue on the GitHub repository.
- Fork this repository.
- Create your new branch with your feature:
git checkout -b my-feature. - Commit your changes:
git commit -am 'feat: My new feature'. - Push to the branch:
git push origin my-feature. - Submit a pull request 👌.
We are students at HUTECH university:
Nguyen Hong Thai |
Truong Thuc Van |
The Hutech Classroom Client App is open source and is licensed under the MIT License.