The instructions in this article are applicable only if you want to tinker with the LuciadRIA sample code yourself.
To start the LuciadRIA samples as they come in the release, without modification, start the sample server with the
Make sure your system setup covers all prerequisites, as described in the Hardware and software requirements.
Extract the LuciadRIA release correctly, following the installation instructions.
npm installin the root of the LuciadRIA distribution.
This command installs all sample dependencies. You must install these once for a release. See Installing dependencies.
Start the sample server with the
startSampleServerscript in the root of the LuciadRIA distribution. See Running the sample server for more information.
npm run devin the directory of the sample you want to edit and run.
A browser window opens automatically. It runs your sample and watches the files in that directory. If you edit and save a file in that directory, the running sample changes automatically, and the browser window refreshes. See Running a webpack dev-server for a sample.
Before you can deploy the samples in the
samples/ directory, you must install all dependencies of the LuciadRIA distribution and its individual samples.
To install the dependencies, you must execute
npm install in the root of the LuciadRIA distribution.
This command installs all development dependencies declared in the root
package.json and the ones declared in the
package.json of the workspaces that are defined.
The NPM workspaces also take care of dependency hoisting: dependencies that are common to different samples are only installed
once in a higher-level
After installing the dependencies of all samples, you can set up your web application.
Several samples don’t fetch their data locally, but request it from a server, or use other data services.
The LuciadRIA distribution offers a sample server to host those services.
You can run the sample server by executing the
startSampleServer script. http://localhost:8072 hosts the server by default.
When you’re developing an application, it’s useful to run a development server, or dev-server. A development server serves the application and watches the source files for changes. It serves those changes without a server restart. To start a webpack dev-server for a sample application in the LuciadRIA distribution:
Make sure that you have bootstrapped the sample dependencies, as explained in Installing dependencies.
Go to the
samples/directory and execute
npm run dev.
By default, a dev-server starts hosting the First Sample on
http://localhost:3001/. It also watches the bundled files so that it can pick up and serve any changes in the source code or styling as long as it’s running.
You can also add arguments to
npm run dev by adding
-- and one or more argument tags at the end:
Specify the port on which the webpack dev-server must run.
Set this argument to run the sample using a WebGL map.
Set this argument to run the sample using a 3D WebGL map.
Specify the URL and port on which the sample server is running.
For example, if you want to run on port 3002, you run the following command:
npm run dev -- --port=3002
Make sure to insert the double dashes
The webpack configuration file of all samples extends from
samples/common/webpack.config.js. See the webpack configuration web page for more information.
Building and running samples may require a significant amount of memory. To execute the build, you need to configure
the amount of memory that Node.js can use. You can do so by setting the NODE_OPTIONS environment variable to
To build and run the application, take these steps:
npm run buildcommand in the sample directory.
The sample is packaged to
The original sample in that directory will be overwritten, so it might be a good idea to back that up first.
Start the sample server by running the
Open your browser, and point it to
http://localhost:8072/samples/<sample>. A new web page displays your application.
This uses the same webpack configuration file as discussed in Running a webpack dev-server for a sample.
When you’re deploying a real application, just running the provided webpack dev-server isn’t enough. You must take care of other steps, such as minification/uglification or chunk splitting as well, before you can serve the application.
Some samples contain TypeScript code.
You can do this by running
npm run transpile-to-js in the sample directory.
This command generates a
./transpiled directory inside the sample.
Optionally, you can also generate TypeScript declaration files (
.d.ts files) in the transpiled directory by running
npm run transpile-declarations in the sample directory.
The UI components in the LuciadRIA samples have been implemented with React. We use React in our sample code because it’s a very popular UI library.
Note that you don’t have to use React with LuciadRIA. You’re free to use any UI library you want. Even if you’re using a different UI library, such as Angular or Vue, you can still use the sample code as inspiration for your own UI components.
This NPM package contains modules that are commonly used across LuciadRIA samples.
A sample based on a single map that covers the entire window. It has a
SampleMap, overlay components, and a placeholder for UI below the map, such as the
bottomBarproperty. Most LuciadRIA samples are based on this component.
A sample based on 2 maps that cover the entire window. It has 2
SampleMapcomponents, each with its own overlay components.
This folder contains a bunch of overlay components, such as a layer tree UI, a mouse location components, a scale indicator, and navigation controls.
This file contains CSS variables and common styles that all LuciadRIA samples use.