https://github.com/silveirinhajuan/lux
LUX is a smart application designed to track and analyze study habits, helping users optimize their learning performance. With features that include data tracking and metric generation, LUX provides valuable insights to improve study routines.
https://github.com/silveirinhajuan/lux
Last synced: 6 months ago
JSON representation
LUX is a smart application designed to track and analyze study habits, helping users optimize their learning performance. With features that include data tracking and metric generation, LUX provides valuable insights to improve study routines.
- Host: GitHub
- URL: https://github.com/silveirinhajuan/lux
- Owner: silveirinhajuan
- Created: 2024-12-10T15:27:15.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-12-12T12:14:45.000Z (10 months ago)
- Last Synced: 2025-02-12T16:27:52.021Z (8 months ago)
- Language: Python
- Homepage:
- Size: 114 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌟 LUX - Learning Unleashed eXcellence
   
## 📚 About the Project
**LUX** is a smart application designed to track and analyze study habits, helping users optimize their learning performance. With features that include data tracking and metric generation, LUX provides valuable insights to improve study routines.
---
## 🗂️ Project Structure
```
LUX/
│
├── imgs/
│ └── logo.webp # Project logo
│
├── src/
│ └── main.py # Main application logic
│
├── venv/ # Virtual environment for dependencies
│
├── database.db # SQLite database for data storage
│
├── .gitignore # Git ignore file
│
└── requirements.txt # Project dependencies
```
---
## 🚀 Getting Started
Follow these steps to run the project locally:
1. **Clone the repository**:
```bash
git clone https://github.com/silveirinhajuan/LUX.git
cd LUX
```
2. **Set up a virtual environment**:
```bash
python -m venv venv
source venv/bin/activate # Linux/Mac
venv\Scripts\activate # Windows
```
3. **Install dependencies**:
```bash
pip install -r requirements.txt
```
4. **Run the application**:
```bash
python src/main.py
```
---
## ✨ Features
- 📊 **Data Management**: Logs and processes data related to study performance.
- 📈 **Metrics Generation**: Creates charts for progress tracking and analysis.
- 🎨 **Minimalist Interface**: Designed for a smooth and distraction-free user experience.
---
## 🔧 Technologies
- **Python**: Core programming language
- **SQLite**: Lightweight and efficient database
- **Libraries**:
- [Py-Telegram-Bot](https://python-telegram-bot.org/) (for UI)
- [Matplotlib](https://matplotlib.org/) (for chart generation
---
## 🎥 Demo Video
https://github.com/user-attachments/assets/ef5ae534-93e0-4e52-9c54-8b2dec6df9ab
## 🤝 Contributing
We welcome contributions! Feel free to open **issues** or submit a **pull request** to enhance the project.
---
## 📄 License
This project is licensed under the [MIT License](LICENSE).