Skip to content

ditpowuh/flexular

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

flexular

An open-source multipurpose Electron app that is made to be modular and flexible (hence the name).

Overview

This was originally made so that I could avoid making separate entire apps for some small things I wanted.

Main contains a lot of the main assets and resources for the app, including the styling, the menu bar and the side bar.
Modules contains the different modules that can be used in the app, which can include the default ones and your custom ones.

Flexular Module Structure

index.html in the root of your module will be the first page that it is opened up to when navigated to by the side bar.
index.js in the root of your module is run in the backend when the app is opened.

The rest of the structure can be anything within the module. Though for consistency, CSS should contain CSS files and JS should contain JavaScript files.

Compiling/Packaging

Use npm install to install all base dependencies and Flexular module dependencies.

Universal

npx @electron/packager . Flexular --icon=Main/Icon.png --out=output/ --overwrite --ignore="\.bat$"

Preinstalled/Default Flexular Modules

  • timewatch - Tracks multiple stopwatches.
  • nurture - Sends reminders to the user via notifications to drink water.
  • template - This module serves to be a template to make modules.

See the README.md of respective module to find more information.

About

A multipurpose Electron app that is made to be modular and flexible

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published