Skip to content

darwishzain/recluse-board

Repository files navigation

Project Name

A dashboard for daily use function


🚀 Features

  • ✅ Time, date and Pomodoro timer
  • ✅ Audio player
  • ✅ Shortcuts to links and commands
  • 🧪 Calendar
  • 🎯 Configurable links and command in app

📦 Installation

Prerequisites

  • Python 3.11+ (Check version: python --version)
  • Recommended: Use a virtual environment (venv)

Setup

  1. Clone the repository:

    git clone https://github.com/darwishzain/recluse-board.git
    cd recluse-board
  2. Create and activate a virtual environment:

    python -m venv venv
    source venv/bin/activate   # On Windows: venv\Scripts\activate
  3. Install dependencies:

    pip install -r requirements.txt
  4. Run the project:

    python src/main.py

🤝 Contributing

  1. Fork the repository
  2. Create a branch: git checkout -b feature-name
  3. Commit changes: git commit -m "Added a new feature"
  4. Push to GitHub: git push origin feature-name
  5. Create a Pull Request

📜 License

This project is licensed under the GNU General Public License v3.0. See LICENSE for details.


📞 Contact

For any inquiries, contact:
[email protected]
🐙 GitHub: darwishzain


Stargazer

Stargazers repo roster for @darwishzain/recluse-board


🚀 Happy Coding! 🎉