Welcome to CrackEd, an educational platform designed specifically for the Islamic University of Technology (IUT), Bangladesh, admission test. This documentation provides a comprehensive overview of the installation process, platform’s features and functionalities, categorized for students, tutors, and admins.
This project is developed by our team, XtraDrill, for the Software Project Lab (SWE 4404) during the 4th semester at the Islamic University of Technology. It is a fullstack application capable of handling a large number of users.
- Tools and Technologies
- Installation Process
- Features for Students
- Features for Tutors
- Features for Admin
- Developers
- Conclusion
CrackEd is built using the following tools and technologies:
- MERN Stack:
- Frontend: React
- Backend: Node.js, Express.js
- Database: MongoDB Atlas
To set up and run CrackEd locally, follow these steps:
-
Node.js and npm: Ensure you have Node.js and npm installed. You can download and install them from Node.js official website.
-
MongoDB: Install MongoDB and start the MongoDB server. You can download it from MongoDB official website.
-
Git: Ensure you have Git installed to clone the repository. You can download it from Git official website.
-
IDE: It is recommended to use Visual Studio Code (VS Code) for development. You can download it from VS Code official website.
-
Clone the Repository:
git clone https://github.com/imtiaz-risat/Cracked-SPL-II.git cd Cracked-SPL-II -
Install Dependencies: Navigate to the
clientdirectory and install the required npm packages.npm install cd client npm install -
Run the Application: To run both the frontend and backend concurrently, use the following command from the root directory:
npm run dev
-
Browser Compatibility: Ensure you are using a modern browser such as Google Chrome, Mozilla Firefox, Microsoft Edge, or Safari.
-
Open the Application: Once both servers are running, open your browser and navigate to
http://localhost:3000to access the CrackEd platform.
The Student Dashboard serves as the central hub for students, providing quick access to various features such as model tests, mock tests, leaderboard, and performance statistics represented through a PieChart.
This feature allows students to post their doubts, manage existing doubts, and view answers provided by teachers. It ensures that students receive timely assistance and clarification on their queries.
Students can create and participate in mock tests by selecting the subject, marks, and time limit. This feature is designed to help students prepare effectively for their exams.
The Student Model Test feature provides a list of live and archived model tests. Students can participate in live tests and review archived ones to enhance their learning experience.
Students can view and update their personal information, choose an avatar, and change their password with proper validation to ensure account security.
Students have access to a repository of previous admission tests listed by year, which they can use for practice and preparation.
This feature enables students to take exams specifically based on the questions they have previously answered incorrectly, allowing them to focus on areas where they need improvement. Additionally, on the Mistake Exam page, students can view detailed statistics on the number of incorrect answers they have made, both for individual subjects and combined across all subjects.
The Tutor Dashboard provides an overview of key metrics and resources, including the total number of questions, pending reviews, and live model tests. It helps tutors manage their tasks efficiently.
This feature allows tutors to view, add, edit, and delete questions for various subjects. It also provides question counts per subject to help tutors keep track of their contributions.
Tutors can create, manage, and review model tests with options to specify test details. The search and filter functions make it easy to find specific tests or questions.
Tutors can view and update their profile information, choose an avatar, and change their password with validation to ensure their account's security.
The Doubt Reviews feature enables tutors to review and answer student doubts. It provides a list of doubts and a submit answer button for resolving queries, ensuring that students receive prompt and accurate assistance.
The Admin Dashboard offers a high-level overview of platform activity, showing counts for the total number of students and tutors. This feature helps admins monitor and manage the platform effectively.
- URL:
/sys-admin-cracked - Credentials: Username: admin, Password: CRACKed
Admins can register new tutors to the platform, ensuring that the platform has sufficient teaching resources to cater to the students' needs.
Admins can view, search, manage, and perform actions on the student base. Key features include:
- Search Functionality: Filter students by username or email.
- List of Students: Displays username, email, gender, and date of birth.
- Actions:
- Ban/Unban Student: Toggle the ban status of a student.
- Delete Student: Remove a student account from the platform.
Admins can view, search, manage, and perform actions on the tutor base. Key features include:
- Search Functionality: Filter tutors by username or email.
- List of Tutors: Displays username, email, gender, and date of joining.
- Actions:
- Ban/Unban Tutor: Toggle the ban status of a tutor.
- Delete Tutor: Remove a tutor account from the platform.
The CrackEd project is developed and maintained by @codenim34, @takitajwar17, and @imtiaz-risat.
CrackEd is designed to provide a comprehensive and efficient learning and teaching environment for students and tutors. With a range of features tailored to meet the needs of both parties, CrackEd ensures a seamless educational experience.