https://github.com/mbeggiato/conventionalfighter

A web GUI for generating conventional commit messages following the Conventional Commits specification.
https://github.com/mbeggiato/conventionalfighter

commit commit-message commit-messages conventional-commits conventions svelte sveltekit

Last synced: 2 days ago
JSON representation

A web GUI for generating conventional commit messages following the Conventional Commits specification.

• Host: GitHub
• URL: https://github.com/mbeggiato/conventionalfighter
• Owner: MBeggiato
• Created: 2024-11-06T19:24:45.000Z (9 days ago)
• Default Branch: main
• Last Pushed: 2024-11-07T21:52:35.000Z (8 days ago)
• Last Synced: 2024-11-14T05:12:06.562Z (2 days ago)
• Topics: commit, commit-message, commit-messages, conventional-commits, conventions, svelte, sveltekit
• Language: Svelte
• Homepage: https://mbeggiato.github.io/ConventionalFighter/
• Size: 149 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ConventionalFighter

ConventionalFighter (CF) aims to create an easy way to generate conventional commit messages by providing a [simple web GUI](https://mbeggiato.github.io/ConventionalFighter/).

CF follows the Conventional Commits specification 1.0.0 found [here](https://www.conventionalcommits.org/en/v1.0.0/).

## Why Use Conventional Commits

- Automatically generating CHANGELOGs.

- Automatically determining a semantic version bump (based on the types of commits landed).

- Communicating the nature of changes to teammates, the public, and other stakeholders.

- Triggering build and publish processes.

- Making it easier for people to contribute to your projects by allowing them to explore a more structured commit history.

## Getting Started

### Prerequisites

- Node.js (version 14 or later)

- npm (version 6 or later)

### Installation

1. Clone the repository:

    ```sh

    git clone https://github.com/mbeggiato/ConventionalFighter.git

    cd ConventionalFighter

    ```

2. Install dependencies:

    ```sh

    npm install

    ```

### Running the Application

To start the development server, run:

```sh

npm run dev

```

This will start the application at `http://localhost:5173/`.

### Building

To build this project run

```sh

npm run build

```

> [!TIP]  

> Checkout this projects GitHub actions to learn more about building and deploying.

## License

This project is licensed under the MIT License.