• Overview
• Use Toolzy in your projects
• Getting Started
  • Prerequisites
  • Installation
  • Testing
• Documentation
• Project Structure
• License

Overview

Toolzy is your go-to toolkit for simplifying common tasks in JavaScript and TypeScript projects.

Why Toolzy ?

This project enhances development efficiency by providing essential utilities that streamline your coding processes. The core features include:

• 🎲 Reusable Functions: Simplifies common tasks, reducing code duplication and enhancing.
• 🔤 String Manipulation: Offers powerful text processing functions for improved readability and web optimization.
• #️⃣ ArrayOperations: Includes shuffling functionality to randomize elements, perfect for games and sampling.
• 🔢 Random Number Generation: Generates random integers.
• 🛠️ TypeScript Support: Ensures type safety and adherence to modern JavaScript standards for better code quality.
• 📦 Lightweight and Modular: Easily integrates into existing projects, promoting a clean and maintainable codebase.

Use Toolzy in your projects

1. Install the dependency into your project:
   Using npm:

   > npm install toolzy

2. Import the methods needed in you project files:
   For example:

   import { randomInt } from 'toolzy';
     
   const number = randomInt(0, 10);

Getting Started

Prerequisites

This project requires the following dependencies :

• Programming Language: TypeScript
• Pakcage Manager: Npm

Installation

Build Toolzy from the source and install dependencies:

1. Clone the repository:

   > git clone https://github.com/Tr0lgar/toolzy

2. Navigate to the project directory:

   > cd toolzy

3. Install the dependencies:
   Using npm:

   > npm install

🧪 Testing

Toolzy uses Vitest test framework. Run the test suite with:

Using npm:

> npm test

🔗 Documentation

• Documentation : https://tr0lgar.github.io/toolzy-doc/
• NPM Package : https://www.npmjs.com/package/toolzy

📁 Project Structure

toolzy/
├── src/
│   ├── index.ts
│   ├── random.ts
│   ├── string.ts
│   ├── array.ts
│   └── ...
├── tests/
│   └── *.test.ts
├── dist/
├── package.json
├── tsconfig.json
└── README.md

📝 License

MIT — @Tr0lgar