LZW Algorithm Tool

A small tool written in JavaScript for compressing and decompressing texts using the LZW algorithm for educational purposes. Each step of the compression is listed in a table for (hopefully) easier understanding of how the algorithm works and can be used to compress images into formats like GIF.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage

About The Project

This simple tool allows you to compress and decompress texts using the LZW algorithm. The steps that are taken during the process are shown in a table for better understanding of how the algorithm works. This is mainly intended for educational purposes, as this algorithm is traditionally used to compress image files like GIF.

I hope you will have fun experimenting with it!

(back to top)

Built With

(back to top)

Getting Started

Getting started is relatively easy. The only further tool you need is the Node.js manager npm and a web browser of your choice.

Prerequisites

First install npm for your operating system. You can find installation instructions in the official documentation. To install the latest version, run:

npm install npm@latest -g

Installation

Installation is straightforward. After installing npm and Node.js, follow these steps:

1. Clone repository and navigate into the directory it creates

   git clone https://github.com/zevsky404/lzw-algorithm-tool.git

2. Install NPM packages

   npm install

3. Run the start script to start up the web server

   npm run start

(back to top)

License

Distributed under the GNU General Licence. See LICENSE.txt for more information.

(back to top)