Skip to content

Latest commit

 

History

History
113 lines (69 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

113 lines (69 loc) · 3.49 KB
Raw

Hello, and thanks in advance for contributing to maprayJS. Here's how we work. We haven't written a contributor guide or coding rules yet, so we will continue to enhance the content in the future. This document first explains how to build maprayJS.

Preparing your Development Environment

Following packages are required to build maprayJS.

  • node (v16 or later)
  • yarn
    • Yarn workspace is used in maprayJS.
    • Note: on MacOS it is often convenient to install node and yarn with brew

Build

Clone the repository

git clone https://github.com/sony/mapray-js.git

Build wasm module before building maprayJS

To build maprayJS, you need to build the wasm module first. Follow build instraction part of the README to install and build wasm module.

Build maprayJS

install dependencies

Dependent packages are installed under ui and mapray packages.

cd mapray-js
yarn install

build

A standalone build allows you to turn the contents of this repository into js files, mapray.js, maprayui.js, and mapray.css files that can be included on html pages through umd and es modules.

yarn build

Following files will be generated in each directory.

path summary
/packages/mapray/dist build result of mapray package
/packages/ui/dist build result of ui package
/doc/typedoc API Referende

API Reference

You can create integrated document accross workspaces with the following command.

yarn run typedoc

The document is generated in /doc/typedoc.

Other Commands

You can also use following commands.

yarn run <command>
command summary
build build mapray ui css doc (build-devel)
mapray build mapray package (mapray-devel, mapray-watch)
ui build ui package (ui-devel, ui-watch)
css build css
doc build doc (doc-watch, doc-devel, doc-devel-watch)
lint lint code (lint-mapray, lint-ui)
test execute test-expression and test-browser
test-expression execute expression test
test-browser execute browser test (playwright)
test-browser-setup setup browser test (install & downloading golden images)
test-browser-make-image generate the golden image with the current version of the software

Testing maprayJS

There are two types of test.

  • expression test: See packages/mapray/tests/README.md
  • browser test: See browser-test

Serving the application for development

You can use debug applications under debug for development.

Contributing by Pull Request

We appreciate contributors in the community, that are willing to improve maprayJS. Please create a pull request of your development branch to main branch. Our maintainers will then review your changes.