arcs.js-components

arcs.js-components

About ARCS.js Components

This repository stores some components for ARCS (Augmented Reality Component System). More can be found on http://arcs.ibisc.univ-evry.fr.

How to setup a set of components

The first thing is to download the repository since it will usually serve as a basis for application development.

ARCS.js is using two tools in order to setup components:

We suppose that npm is already installed. Then, you will have to setup your development environment by typing these commands, the last one being executed in the local sources repository:

npm install -g webpack-cli

npm install -g eslint

npm install

In order to build or rebuild the engine, you will have to call webpack. If you prefer, it is included as a command in file package.json. To generate documentation and prepare components, type npm run setup

Creating an application

The first thing is to create a directory, then start a repository using npm and install arcs.

mkdir myapp

npm init -y

npm install arcsjs

To install components on a per need basis, you should a component repository that is setup. You can do it locally by running:

npx arcsrepos -d path_to_components

Then you set a repository environment variable or specify it on command line each time you install a component:

export ARCS_REPOSITORY=/path/to/components/repository.json

npx arcsm -i library_or_component_name

Or you can do it like this:

npx arcsm -i library_or_component_name -r /path/to/components/repository.json