Skip to content

HeaderMaker is a simple application for easily adding and removing headers from project files within a selected directory.

License

Notifications You must be signed in to change notification settings

NewBumpEr/HeaderMaker

Repository files navigation

HeaderMaker

HeaderMaker Logo

Table of Contents


Introduction

HeaderMaker is a desktop application designed to create custom header comments for your code files within a selected directory. Whether you're a developer looking to standardize your codebase or a project manager aiming for better code documentation, HeaderMaker provides seamless header generation.


Features

  • Customizable Header Formats: Define and customize your header formats to match your project's needs.
  • Intuitive User Interface: Navigate the application effortlessly with a clean and modern UI.
  • Real-Time Preview: See your header designs update instantly as you modify them.
  • Multiple File Support: Generate headers for various file types, including JavaScript, TypeScript, JSX, TSX, HTML, and CSS, with more file types coming soon.

Installation

Follow these steps to install HeaderMaker on your system:

  1. Clone the Repository:
 git clone https://github.com/NewBumpEr/HeaderMaker.git
  1. Navigate to the Project Directory:
 cd headermaker
  1. Install Dependencies:
 npm install
  1. Run the Application:
 npm start

Note: Ensure you have Node.js installed on your machine.


Screenshots

Here are some screenshots of HeaderMaker in action:

Home Screen

Home Screen

Customization Panel

Customization Panel


License

This project is licensed under the MIT License. See the LICENSE file for details.


Contact

For any questions or feedback, please contact:

Feel free to open an issue on GitHub if you encounter any problems or have suggestions for improvement.