Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 2.34 KB

README.md

File metadata and controls

66 lines (45 loc) · 2.34 KB

Electrical Panel Label

License: MIT

Electrical Panel Label is a simple, open-source web application that allows you to design, customize, and generate labels for electrical panels easily. Born out of a personal need and the desire to provide a free, subscription-less alternative to the community, this project aims to simplify the process of creating clear, customizable labels for your electrical panel.

Features

  • Create and manage multiple module rows
  • Customize each module with built-in and custom icons, colors, and descriptions
  • Upload and manage your own SVG icons
  • Reorganize modules using drag and drop
  • Save and load work sessions
  • Generate print-ready SVG labels
  • Multilingual support (English and French)

Live Demo

Try out Electrical Panel Label without any login: 🔗 https://electrical-panel-label.vercel.app

Simply click the link above or check out the "About" section on the right side of this GitHub page for quick access to the live application.

Getting Started

To run this project locally:

  1. Clone the repository
  2. Install dependencies with npm install
  3. Run the development server with npm run dev
  4. Open http://localhost:3000 in your browser

Usage

  1. Create a new session or load an existing one
  2. Add rows and modules to your panel layout
  3. Customize modules with icons, descriptions, and colors
  4. Arrange modules using drag and drop
  5. Generate and download your SVG label
  6. Print your label directly from the application

Contributing

While this project is primarily maintained by a single developer, contributions, suggestions, and bug reports are welcome. Please open an issue or submit a pull request if you'd like to contribute.

Note on Testing

As a simple, personal project, Electrical Panel Label currently doesn't have a test suite. While this may change in the future, there are no immediate plans to implement testing.

License

This project is open source and available under the MIT License.

Acknowledgements

Thank you for checking out Electrical Panel Label! I hope you find it useful for organizing your electrical panel.