Skip to content

Latest commit

 

History

History
47 lines (25 loc) · 1.61 KB

DEVELOPING.md

File metadata and controls

47 lines (25 loc) · 1.61 KB

Developing

Setting up development environment

You will start by forking the XYZ repository.

Development dependencies

The minimum requirements are:

  • Git
  • Node.js (version 18 and above)

The executables git and node should be in your PATH.

To install the Node.js dependencies run

$ npm install

Please check the full list of dependencies as defined in the package.json

ESBuild

The MAPP and MAPP.UI library must be build with esbuild prior to launching the host.

$ npx esbuild ./lib/mapp.mjs ./lib/ui.mjs --bundle --minify --tree-shaking=false --sourcemap --format=iife --outdir=./public/js/lib

The build command is stored in the package.json as _build script.

$ npm run _build

ESBuild must also be used to compile the CSS supporting the MAPP and MAPP.UI elements.

$ npx esbuild --bundle public/css/_mapp.css --outfile=public/css/mapp.css

$ npx esbuild --bundle public/css/_ui.css --outfile=public/css/ui.css --loader:.svg=dataurl

Express

Express.js will be installed by npm as a development dependency. You can run a zero config instance by loading the express.js script in your node runtime.

$ node express.js

The default port is 3000. You can access the mapp interface on http://localhost:3000/ in your browser.

Please refer to the Getting Started wiki page for the next steps in regards to workspace configuration and environment variables.