https://github.com/apostrophecms/import-export-xlsx

XLSX format for import-export module
https://github.com/apostrophecms/import-export-xlsx

Last synced: about 2 months ago
JSON representation

XLSX format for import-export module

• Host: GitHub
• URL: https://github.com/apostrophecms/import-export-xlsx
• Owner: apostrophecms
• License: mit
• Created: 2024-04-24T13:56:20.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-15T18:25:00.000Z (8 months ago)
• Last Synced: 2024-10-06T10:47:55.110Z (3 months ago)
• Language: JavaScript
• Size: 13.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  


  
XLSX format for Import Export Module

  


    

      

    

    

      

    

    

      

    

  



This module improves [@apostrophecms/import-export](https://github.com/apostrophecms/import-export) by adding the `xlsx` format.

> Why does this specific format lies in another module?

Because it relies on a [dependency that is not hosted on NPM](https://github.com/SheetJS/sheetjs/issues/2667), which could lead to installation issues on networks that limit connections to NPM repository only.

## Requirement

[@apostrophecms/import-export](https://github.com/apostrophecms/import-export) should be installed and instantiated.

Please refer to the module's [README](https://github.com/apostrophecms/import-export#readme) before continuing.

## Installation

To install the module, use the command line to run this command in an Apostrophe project's root directory:

```

npm install @apostrophecms/import-export-xlsx

```

## Usage

Configure the module in the `app.js` file:

```javascript

require('apostrophe')({

  shortName: 'my-project',

  modules: {

    '@apostrophecms/import-export': {},

    '@apostrophecms/import-export-xlsx': {}

  }

});

```

> Please note that `apos` is not passed to the `input` and `output` functions of the format, as they should remain agnostic of apostrophe and only deal with retrieving and writing the documents from/to the `.xlsx` file.