https://github.com/newbumper/headermaker
HeaderMaker is a simple application for easily adding and removing headers from project files within a selected directory.
https://github.com/newbumper/headermaker
code-documentation code-organization comments desktop-application electron electron-app file-header file-headers header header-generator headers javascript js
Last synced: about 2 months ago
JSON representation
HeaderMaker is a simple application for easily adding and removing headers from project files within a selected directory.
- Host: GitHub
- URL: https://github.com/newbumper/headermaker
- Owner: NewBumpEr
- License: mit
- Created: 2024-07-28T15:20:56.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-18T14:13:27.000Z (9 months ago)
- Last Synced: 2025-04-14T23:12:15.534Z (about 2 months ago)
- Topics: code-documentation, code-organization, comments, desktop-application, electron, electron-app, file-header, file-headers, header, header-generator, headers, javascript, js
- Language: JavaScript
- Homepage:
- Size: 771 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HeaderMaker
---
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Screenshots](#screenshots)
- [Contact](#contact)
---
## 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:**
```bash
git clone https://github.com/NewBumpEr/HeaderMaker.git
```
2. **Navigate to the Project Directory:**
```bash
cd headermaker
```
3. **Install Dependencies:**
```bash
npm install
```
4. **Run the Application:**
```bash
npm start
```
---
> **Note:** Ensure you have [Node.js](https://nodejs.org/) installed on your machine.
---
## Screenshots
Here are some screenshots of HeaderMaker in action:
### Home Screen
### Customization Panel
---
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
---
## Contact
For any questions or feedback, please contact:
- **Author:** Pavlo Mytrovtsiy
- **Email:** [[email protected]](mailto:[email protected])
- **GitHub:** [Bump_Er](https://github.com/NewBumpEr)
Feel free to open an issue on GitHub if you encounter any problems or have suggestions for improvement.
---