README-Updated: 2025-05-15
A Group Project for Big Data Analytics with Dash.
The Learner Information System Dashboard is a web-based application built using Python and the Dash framework. It provides a user-friendly interface for managing and visualizing learner information, offering features like dashboards, analytics, and customizable settings.
learner_dashboard/
├── app.py # Main Dash app
├── assets/
│ ├── style.css # Custom CSS filepreview of md file in vs code
├── layout/
│ ├── sidebar.py # Sidebar layout and menu items
│ ├── page_router.py # Handles page routing
│ ├── cards.py # Card component for displaying information
│ ├── header.py # Header component
│ └── pages/
│ ├── dashboard.py # Dashboard page
│ ├── enrollment.py # Enrollment page
│ ├── help.py # Help page
│ └── settings.py # Settings page
├── data_files/ # Data files (CSV, JSON, etc.)
│ └── user-info.csv # Example user data
├── requirements.txt # Dependencies like Dash, Plotly, etc.
└── README.md # Project documentation
- Dashboard: An overview page with key metrics and insights.
- Analytics: Placeholder for exploring and analyzing learner-related data.
- Help: Guidance and information about using the application.
- Settings: Configure application settings, including account and general settings.
- Collapsible Sidebar: A navigation sidebar that can be collapsed for more screen real estate.
- Dynamic Greeting: Displays a personalized greeting based on the time of day.
- Responsive Design: Adapts to different screen sizes for better usability.
- Python: The primary programming language.
- Dash: A Python framework for building analytical web applications.
- Dash Bootstrap Components (dbc): A library of Bootstrap components for Dash.
- Pandas: For data manipulation and analysis.
- Plotly: For creating interactive charts and graphs.
- Python 3.x installed on your system.
- pip (Python package installer) installed.
-
Clone the repository:
git clone <repository_url> cd learner_dashboard
-
Create a virtual environment (recommended):
python -m venv venv source venv/bin/activate # On macOS/Linux venv\Scripts\activate # On Windows
-
Install the required dependencies:
pip install -r requirements.txt
- Navigate to the project directory in your terminal.
- Run the
app.pyfile:python app.py
- Open your web browser and go to
http://127.0.0.1:8050/(or the address shown in your terminal).
- Custom Styling: Modify the
assets/style.cssfile to customize the application's appearance. - Temporary Constants: Replace placeholder data in
layout/temp_constants.pywith actual data or implement a dynamic way to fetch this information. - Sidebar Menu: Add, remove, or modify menu items in the
create_sidebarfunction inlayout/sidebar.py.
Thank you to all our colleagues for the shared effort, ideas, and collaboration that made this project possible. The Learner Information System Dashboard is a product of our collective work and dedication.
- Project Lead: Dale Menciro
- Data Scientists: Andrei Cruz, Christian Dating
- Data Engineers: Jerome Hontiveros, Ezrhael Sicat
- Data Analyst: Christian Luces
- UI/UX Design: Mary Cammagay, Regine Dahan
Contributions to this project are welcome. Please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them.
- Push your changes to your fork.
- Submit a pull request.
This project is currently not licensed. Please contact the repository owner(or collaborators) for more information.
Future enhancements could include (but are not limited to):
- Implementing the analytics page with actual data visualization..
- Implementing user authentication and authorization.
- Connecting to a real database to fetch and manage learner information.
- Implementing a caching mechanism to improve performance.
- Implementing a notification system for important updates or alerts.
- Adding unit tests and documentation for better maintainability.