Skip to content
This repository has been archived by the owner on Mar 3, 2025. It is now read-only.

microsoft/data-science-editor-excel

Repository files navigation

Data Science Editor

Prototype integration of the Data Science Editor in Office for the Web.

A gif showcasing the app in action.

Developer Zone

These instructions will show you how to build and debug the Office App locally.

Getting Started

These instructions have been tested on Windows only.

  1. Download the latest LTS version of node.js.
  2. Install all dependencies.

npm run install

Build

The following script will build and place assets in the dist directory:

npm run build

Lint

Runs prettier over all typescript files

npm run lint

Manual Test

  1. Run the following script to start the dev server:
    • npm run server
  2. Manually sideload the add-in to Office on the web
  3. select manifest-local.xml

Testing the hosted data science editor locally

Architecture

This add-in is a host to an iframe that holds the data science editor. This Add-In provides the interface to allow the data-science editor to interact with Excel.

This add-in is complete static and hosted on a github pages site.

Layout

Layout of folders

  • assets

    • image assets
  • src

    • source code for the add-in
  • listing

    • descriptions for the add-in store listing
  • hosted_files

    • additional hosted files
  • scripts

    • development scripts
  • config

    • tooling configuration files
  • dist

    • the build site, this is the exact layout hosted

Add-In Manifest

Generate production manifest.xml from manifest-local.xml

Make all manifest changes to manifest-local.xml.

When the local manifest changes run:

npm run manifest

The command:

  • check that the local manifest is valid
  • generates the production manifest.xml
  • checks the production manifest is valid

Requirement Set

The Manifest is set to require a specific Excel version to avoid having to support specific outdated browser versions.

ExcelApi Requirement Sets and Supported Office Versions