Skip to content

sametcn99/electron-widgets

Repository files navigation

Project Preview

Screenshot

Electron.js NodeJS Vue.js Vite TypeScript Windows MacOS Linux Build

Project Overview

This project is a desktop application developed using Electron.js and Node.js. The application allows users to create and manage widgets on their desktops. These widgets enable users to quickly and easily access the information or tools they need.

Widget Screenshots

Clock
dailyWeather
r/programming
diskusage
hacker-news
transparentClock
search

Features

  • Widget Management: This feature allows users to manage widgets on their desktops effortlessly. They can create new widgets, edit existing ones, and delete widgets they no longer need. This functionality provides users with the flexibility to organize their desktops according to their preferences and needs.

  • Customizable Widget Options: The application offers a variety of widgets such as clocks, weather forecasts, notes, calendars, to-do lists, and more. Each widget comes with a range of customizable options, allowing users to tailor them to their liking. For instance, users can choose different clock formats, select specific locations for weather forecasts, customize the appearance of notes, and set reminders on calendars. This level of customization ensures that users can personalize their desktop experience according to their unique requirements.

  • Ease of Use: The user interface of the application is designed to be intuitive and user-friendly. Even users with limited technical expertise can navigate the application with ease. The interface features clear icons, simple menu structures, and straightforward controls, making it easy for users to understand and interact with the various functionalities offered by the application. Whether users are creating new widgets, customizing existing ones, or managing their desktop layout, they can do so without encountering any unnecessary complexities.

  • Cross-Platform Compatibility: Leveraging Electron.js technology, the application is compatible with multiple operating systems, including Windows, macOS, and Linux. This cross-platform compatibility ensures that users can enjoy a consistent experience regardless of the operating system they use. Whether they are working on a Windows PC, a macOS laptop, or a Linux desktop, users can install and use the application without any compatibility issues. This versatility makes the application accessible to a wide range of users across different platforms, enhancing its usability and appeal.

  • Create Your Own Widgets and Contribute to the Project!: Our project encourages users to create their own widgets and contribute to the project. By creating your own widgets, you can increase the diversity of our project and contribute to the growth and strength of our community. See how

Installation

To install the application, follow these steps:

  1. Clone the project from GitHub:

    git clone https://github.com/sametcn99/electron-widgets.git
  2. Navigate to the project directory:

    cd electron-widgets
  3. Install the required packages:

    npm install
  4. Start the application:

    npm start
  5. Or just run the install.sh

Contribution

For those who want to contribute to the project, you can follow these steps:

  1. Fork the project and clone it to your GitHub account.
  2. Create a new branch (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push your branch to GitHub (git push origin feature/AmazingFeature).
  5. Create a Pull Request.

License

This project is licensed under the GPL 3.0. Feel free to use and modify the code as per your requirements.