Package.json to mass badges generator

Just copy your package.json and paste it to generate badges

Technologies used

Table of Contents

• Overview
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Development
• Testing
• Contributing

Overview

Generate badges for documentation from package.json file.

Getting Started

Prerequisites

Ensure the following are installed on your system:

• Node.js: v18.x or later
• npm: v9.x or later
• Git: For cloning the repository

Installation

Follow these steps to set up the project locally:

1. Clone the repository:

   git clone https://github.com/ryanzam/package.json-to-badges-generator.git

2. Navigate to the project directory:

   cd package.json-to-badges-generator

3. Install dependencies:

   npm install

4. Start the application:

   npm run dev

Usage

Access the application at http://localhost:5173 after starting the server.

Development

• Code Style: Adheres to ESLint and Prettier standards for consistency.
• Build: Run npm run build to create a production build.

Testing

Run tests using the included test suite:

npm test

Contributing

Contributions are welcome! Please fork the repository, create a feature branch, and submit a pull request. Ensure code follows project standards and includes tests.