Skip to content

charlesk513/ACT

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

24 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

ACT

YOUR REVISION HUB

A command-line application designed to help students organize and manage revision materials efficiently. The system allows users to store, update, and access PDFs, books, and other study resources by course unit.
ACT is derived from the creators (Alvin, Charles and Twaha)

πŸš€ Features

  πŸ“‚ Add revision materials (PDFs, books, notes)
  πŸ—‚οΈ Organize resources by course unit
  πŸ”„ Update existing materials
  πŸ” View available resources per subject
  ⚑ Lightweight CLI interface
  πŸ’Ύ Local file storage support
  πŸ› οΈ Tech Stack

Language: Python

Concepts Used:

  • Object-Oriented Programming (OOP)
  • File Handling (File, BufferedReader, FileWriter)
  • Collections (ArrayList, HashMap)
  • Interface: Command Line Interface (CLI)

πŸ“‚ Project Structure

revision-manager/  
│── src/  
β”‚    β”œβ”€β”€ Main.java  
β”‚    β”œβ”€β”€ Material.java  
β”‚    β”œβ”€β”€ CourseUnit.java  
β”‚    β”œβ”€β”€ RevisionManager.java  
β”‚  
│── data/  
β”‚    β”œβ”€β”€ course_units/  
β”‚    β”œβ”€β”€ materials/  
β”‚  
│── README.md  

Example CLI commands:

add "Data Structures" "trees.pdf"

view "Operating Systems"

update "Computer Networks" "network_notes.pdf"

πŸ’‘ System Design Overview

  • Each Course Unit is represented as an object.
  • Each Material (PDF/book) is linked to a course unit.
  • Data is stored locally using file handling.
  • Course Unit β†’ List of Materials

🎯 Future Improvements

  • πŸ” Add user authentication
  • πŸ—„οΈ Integrate a database (e.g., PostgreSQL or MySQL)
  • πŸ”Ž Implement advanced search (by topic, keyword)
  • 🌐 Cloud storage integration
  • πŸ–₯️ GUI version using JavaFX or Swing

πŸ‘¨β€πŸ’» Authors

Kabunga Charles, Lugonvu Joel, Ssenyonjo Twaha

πŸ“„ License

This project is open-source and available under the MIT License.

About

Enable students keep update on what they have to revise and show them progress.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages