Compilation Process [WSL]

[brianblakely]

Wanted to share/document steps that I took to successfully build Perspective. This is on WSL running Ubuntu 20.04 LTS, the latest version at time of writing. It's a relatively untouched install, so some basics like pip needed to be installed.

build task

1. yarn - install bundled toolchain
2. sudo apt-get install pkg-config - required during compilation
3. sudo apt-get install libssl-dev - required during compilation
4. sudo apt-get -y install cmake - install CMake
5. sudo apt-get install libboost-all-dev - install Boost
6. sudo cp -r /usr/include/boost /usr/local/include/boost - move Boost to a place the compiler expects it
7. sudo apt-get install flatbuffers-compiler - install flatbuffers
8. sudo ln -s /usr/bin/flatc /usr/local/bin/flatc - move flatc to a predictable path
9. curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh - install Rust
10. exec bash - reload environment
11. rustup toolchain install nightly - used during compilation
12. rustup component add rust-src --toolchain nightly-x86_64-unknown-linux-gnu - used during compilation
13. curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh - install wasm-pack
14. Edit node_modules/@finos/perspective/package.json to add wildcards to export dirs:

    "exports": {
        ".": {
            "node": "./dist/cjs/perspective.node.js",
            "require": "./dist/umd/perspective.js",
            "import": "./dist/umd/perspective.js"
        },
        "./dist/*": "./dist/*",
        "./cjs/*": "./dist/cjs/*",
        "./esm/*": "./dist/esm/*",
        "./cdn/*": "./dist/cdn/*",
        "./src/*": "./src/*",
        "./src/js/api/client": "./src/js/api/client.js"
        "./pkg/*": "./dist/pkg/*",
        "./package.json": "./package.json"
    },

    Note that client.js also needed to be referenced directly.
15. Do the same as step 14 in node_modules/@finos/perspective-viewer/package.json

build_python task

1. sudo apt install python3-pip - I did not have pip in my PATH
2. pip install numpy - required by build

/docs build

1. export NODE_OPTIONS=--openssl-legacy-provider - I am running node v18; I believe this is necessary for certain issues in Node v17+ at the moment
2. yarn build:webpack
3. yarn start