Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 2.58 KB

README.md

File metadata and controls

74 lines (51 loc) · 2.58 KB
Raw

xlsx-express-operations

  • is a Node.js app designed to generate and stream Excel files through various methods using Express. It demonstrates different techniques for creating and serving Excel files using ExcelJS and XLSX libraries.

Features

  • Multiple Endpoints: Offers various endpoints to showcase different ways to generate and stream Excel files.
  • ExcelJS and XLSX Support: Supports both ExcelJS and XLSX libraries for Excel file generation.
  • Streamlined with Express: Integrated seamlessly with Express for easy handling of HTTP requests and responses.

Endpoints

  • /download-exceljs-1: Buffer Generates an Excel file using exceljs with a workbook.xlsx.write.
  • /download-exceljs-2: Stream Generates an Excel file using exceljs with a workbookWriter and streams it through a PassThrough stream (highWaterMark: 1024).
  • /download-exceljs-3: Stream Generates an Excel file using exceljs with a workbookWriter and streams it through a PassThrough stream (highWaterMark: 16 * 1024).
  • /download-exceljs-4: Stream Generates an Excel file using exceljs with a workbookWriter and streams it to response.
  • /download-xlsx-1: Buffer Generates an Excel file using xlsx with a write method.
  • /prepare-exceljs-1: Stream Prepares an Excel template using exceljs.
  • /prepare-xlsx-template-1: Buffer Prepares an Excel template using xlsx-template.
  • /upload-exceljs-1: Uploads an Excel file for processing using exceljs. The file should be uploaded as a form-data with the key file.

Installation

Prerequisites

  • Node.js: Ensure you have Node.js installed on your machine.
  • Docker: Docker and Docker Compose installed.

Local Installation

  1. Clone the repository:

    git clone https://github.com/js-ak/xlsx-express-operations.git
cd xlsx-express-operations

  2. Install the dependencies:

    npm install

  3. Start the server:

    npm start

  4. Access the endpoints via your browser or tools like curl:

    curl http://localhost:3000/download-exceljs-2

Docker Installation

  1. Clone the repository:

    git clone https://github.com/js-ak/xlsx-express-operations.git
cd xlsx-express-operations

  2. Build and start the container using Docker Compose:

    docker compose up -d

  3. The service will be available at http://localhost:3000. You can access the endpoints using your browser or tools like curl:

    curl http://localhost:3000/download-exceljs-2