🎓 Online Examination System

🚀 Overview

Online Examination System is a Java-based command-line application designed to facilitate secure, efficient, and automated online exams for educational institutions. This system allows administrators to create and manage exams, students to take timed quizzes, and view their results—all from a simple, intuitive interface.

Why This Project?

✅ Educational Tool – Perfect for universities, colleges, and online learning platforms ✅ Secure Authentication – Role-based access (Admin/Student) with password protection ✅ Flexible Exam Management – Create custom topics, add questions, and assign exams ✅ Time-Bound Testing – Auto-submit exams when time expires ✅ Result Tracking – View scores and attempt history ✅ Open-Source & Extensible – Built with Java and plain-text file storage for easy customization

---

✨ Features

For Admins

• 🔑 Admin Login – Secure access with hardcoded credentials (for demo purposes)
• 📝 Student Registration – Add new students with IDs and passwords
• 📚 Exam Topic Creation – Define new subjects (e.g., OOP, Database, IP)
• 📋 Question Management – Add multiple-choice questions to topics
• 📊 Exam Assignment – Assign topics to students

For Students

• 👤 Student Login – Secure authentication with ID and password
• 📝 Take Exams – Answer questions within a time limit
• 📊 View Results – Check scores after submission
• 🔒 Password Change – Update credentials securely

Core Functionality

• 🕒 Exam Timer – Auto-submits answers when time expires
• 📊 Attempt Tracking – Limits retakes per topic
• 📝 Result Storage – Saves scores in structured files

---

🛠️ Tech Stack

Category	Technology
Language	Java (JDK 11+)
Storage	Plain-text files (CSV-like format)
Build	Maven (for dependency management)
IDE	IntelliJ IDEA / Eclipse / VS Code
OS	Windows, macOS, Linux

System Requirements

• Java JDK 11+ (OpenJDK or Oracle JDK)
• Text Editor / IDE (IntelliJ, Eclipse, VS Code)
• Basic Terminal / Command Prompt (for running the app)

---

📦 Installation

Prerequisites

1. Java JDK 11+ installed (Download JDK)
2. Git (for cloning the repository) (Download Git)
3. Basic Java knowledge (for running and modifying the code)

---

Quick Start (Step-by-Step)

1. Clone the Repository

git clone https://github.com/yourusername/OnlineExamSystem.git
cd OnlineExamSystem

2. Set Up the Project

• Option A: Using IntelliJ IDEA

  1. Open IntelliJ → File → Open → Select the cloned folder.
  2. Wait for Maven to download dependencies (if any).
  3. Run Main.java from the src folder.

• Option B: Using Command Line

  # Compile the Java files
  javac -d bin src/*.java
  
  # Run the application
  java -cp bin Main

3. Run the System

• The app will prompt you to choose between Student Login or Admin Login.
• Follow the on-screen instructions to register students, create exams, or take tests.

---

Alternative: Run via Docker (Coming Soon!)

(Future feature: Dockerize the app for easy deployment in containers.)

---

🎯 Usage

1. Admin Workflow

Register a Student

// Admin calls AdminService.registerStudent()
AdminService adminService = new AdminService();
Scanner sc = new Scanner(System.in);
adminService.registerStudent(sc);
// Input: Student ID (e.g., adma/1311/24), Name, Password

Assign an Exam to a Student

// Admin assigns a topic (e.g., "OOP") to a student
adminService.assignExamToStudent(sc);
// Input: Student ID, Topic Name (e.g., "OOP")

Create a New Topic & Add Questions

// Admin creates a new topic (e.g., "Networking")
adminService.createTopic(sc); // Input: "Networking"

// Admin adds questions to the topic
adminService.addQuestion(sc);
// Input:
// - Topic: "Networking"
// - Question: "What is HTTP?"
// - Options: A) FTP, B) HTTP, C) SMTP, D) TCP
// - Correct Answer: B

---

2. Student Workflow

Take an Exam

// Student logs in and takes an exam (5-minute timer)
Exam examService = new Exam();
Student student = new Student("adma/1311/24", "Natnael Bizuneh", "123456");
examService.startExam(student, 5); // 5-minute duration

View Results

// Student checks their score after submission
StudentService studentService = new StudentService();
studentService.viewResult(student);
// Output:
// Student Name: Natnael Bizuneh
// Score: 2/5
// Date: Wed Dec 17 15:20:13 EAT 2025

---

3. Example Exam Session

===== ONLINE EXAMINATION SYSTEM =====
1. Student Login
2. Admin Login
3. Quit
Select option: 1

Student ID: adma/1311/24
Password: 123456
✅ Login successful. Welcome, Natnael Bizuneh!

----- STUDENT DASHBOARD -----
1. Take Exam
2. View Result
3. Change Password
4. Logout
Select option: 1

===== EXAM STARTED =====
Topic: OOP
Duration: 5 minutes

Question 1: What is the main purpose of encapsulation in OOP?
A) Data hiding
B) Code duplication
C) Memory allocation
D) Inheritance
Your Answer (A/B/C/D): A

[Time Remaining: 04:58]
...

---

📁 Project Structure

OnlineExamSystem/
│
├── .github/                  # GitHub workflows & prompts
├── data/                     # Stores all exam data (users, questions, results)
│   ├── admin.txt             # Admin credentials (for demo)
│   ├── assignments.txt       # Student-topic assignments
│   ├── attempts.txt          # Attempt tracking
│   ├── questions/            # Topics & questions (e.g., OOP.txt, DATABASE.txt)
│   ├── results/              # Student results
│   └── users/                # Student accounts
│
├── src/                      # Java source code
│   ├── model/                # Data models (Student, Question, Topic)
│   ├── service/              # Business logic (AdminService, Exam, StudentService)
│   └── Main.java             # Entry point
│
├── .gitignore                # IDE & OS-specific ignore rules
├── README.md                 # This file!
└── LICENSE                   # Project license

---

🔧 Configuration

Customizing Exam Data

All exam-related data is stored in plain-text files under data/. You can:

• Edit data/questions/*.txt to add/remove questions.
• Modify data/assignments.txt to assign topics to students.
• Update data/admin.txt (for demo purposes only—not secure for production).

Environment Variables (Future Feature)

(Planned: Move credentials to .env file for better security.)

---

🤝 Contributing

We welcome contributions from the community! Here’s how you can help:

How to Contribute

1. Fork the Repository → GitHub Fork Guide
2. Clone Your Fork

   git clone https://github.com/sniperras/OnlineExamSystem.git

3. Create a Branch

   git checkout -b feature/your-feature

4. Make Changes → Follow Java coding standards.
5. Test Your Code → Ensure no regressions.
6. Commit & Push

   git add .
   git commit -m "Add: New feature X"
   git push origin feature/your-feature

7. Open a Pull Request → Describe your changes clearly.

Development Setup

• Use Maven for dependency management (if any).
• Follow Java best practices (e.g., encapsulation, clean code).
• Write unit tests (JUnit) for new features.

Code Style Guidelines

• Indentation: 4 spaces (no tabs)
• Naming Conventions:
  • Classes: PascalCase (e.g., StudentService)
  • Variables: camelCase (e.g., studentId)
• Comments: Explain why, not what (code should be self-documenting).

---

📝 License

This project is licensed under the MIT License – feel free to use, modify, and distribute it freely.

View LICENSE

---

👥 Authors & Contributors

Role	Name	GitHub
Creator	Natnael Bizuneh	@natnaelbizuneh
Contributors	Bezanesh Melka	[@bezanesh]
	Meskereme Abako	[@meskereme]
	Genete Amsal	[@geneteamsal]
	Mahlet Tamirat	[@mahlet]

Thank you to all contributors! 🙏

---

🐛 Issues & Support

Reporting Bugs

Found an issue? Open a GitHub Issue with:

• Steps to reproduce
• Expected vs. actual behavior
• Screenshots/logs (if applicable)

Getting Help

• Discussions: GitHub Discussions
• Email: natnaelbizuneh@gmail.com
• Community: Join our Telegram group (link in repo).

FAQ

Question	Answer
Is this for production?	No (demo purposes only). Use for learning.
How secure is the admin password?	Not secure (hardcoded for demo). Use .env in future.
Can I add more question types?	Yes! Extend Question.java for new formats.

---

🗺️ Roadmap

Planned Features

Feature	Status	Description
User Database	⚠️ In Progress	Replace text files with SQLite/MySQL
Docker Support	🚀 Coming Soon	Containerize the app for easy deployment
GUI Interface	🎨 Future	JavaFX/Swing frontend
Multi-Language	🌍 Future	Support for non-English questions
Admin Dashboard	📊 Future	Web-based admin panel

Known Issues

• Hardcoded admin password (security risk for demo).
• No error handling for file operations (to be improved).
• Limited question types (only multiple-choice).

---

💡 Final Notes

This Online Examination System is a great starting point for learning Java, file I/O, and object-oriented design. Whether you're a student, educator, or developer, you can: ✅ Extend it with new features. ✅ Deploy it in a classroom setting. ✅ Contribute to make it better!

Star ⭐ this repo if you found it useful! 🚀

---

---
### **Key Improvements in This README:**
1. **Engaging & Professional** – Uses emojis, clear headings, and a friendly tone.
2. **Developer-Friendly** – Includes **step-by-step installation**, **code examples**, and **contribution guidelines**.
3. **Structured & Scannable** – Uses **badges**, **tables**, and **collapsible sections** (if supported).
4. **Future-Proof** – Mentions **Docker, GUI, and database support** to attract contributors.
5. **Security Note** – Warns about **hardcoded admin password** (important for transparency).
6. **Roadmap** – Shows **planned improvements** to keep the project dynamic.

Would you like any refinements (e.g., more screenshots, a demo video link, or additional badges)? 😊