Example Website with @butility Packages

This repository provides an example website that demonstrates the usage of all the packages from the @butility library. It showcases how to integrate and use the various utilities from the package collection in a simple web environment.

Getting Started

Follow the steps below to set up and run the website locally.

Prerequisites

• Node.js installed on your system.
• NPM (Node Package Manager) should be installed along with Node.js.

Installation

1. Clone the repository:

   git clone https://github.com/butility/example.git

2. Navigate to the project directory:

   cd example

3. Install dependencies:

   Run the following command to install all necessary packages, including the @butility packages:

   npm install

   Notice: Extract the @butility folder from node_modules as we don't use any bundler.

Running the Website

1. Start the development server:

   After the installation is complete, you can start the local live server using the following command:

   npm start

2. Open the website:

   The website should now be running locally. Open your browser and navigate to:

   http://localhost:3000
   

   This will serve the example website where you can explore the functionalities of the @butility packages.

Usage

This repository demonstrates how to:

• Integrate @butility packages into a web project.
• Use individual utilities provided by the @butility library in real-world scenarios.

You can modify the code or use it as a reference for your own projects.

License

This project is licensed under the MIT License.