@pixano/core NPM

Pixano Elements

Pixano Elements - Re-usable web components dedicated to data annotation tasks.

IMPORTANT: The Pixano Web Components are a work in progress and subject to major changes until 1.0 release.

Requirements

For development, you will only need Node.js installed in your environement.

Node installation on Windows
Just go on official Node.js website and download the installer. Also, be sure to have git available in your PATH, npm might need it (You can find git here).
Node installation on Ubuntu
You can install nodejs and npm easily with apt install, just run the following commands.
```
sudo apt install nodejs
sudo apt install npm
```
Other Operating Systems
You can find more information about the installation on the official Node.js website and the official NPM website.

If the installation was successful, you should be able to run the following command.

node --version
# v8.11.3

npm --version
# 6.1.0

Usage

The Pixano Elements are divided into packages. Each package can be installed independantly from NPM using the following command:

npm install @pixano/graphics-2d

Each package can contain multiple web components which are regrouped by affinity.

Components overview

Component	Status	Demo
`<pxn-rectangle>`		link
`<pxn-polygon>`		link
`<pxn-segmentation>`		link
`<pxn-smart-rectangle>`		link
`<pxn-cuboid-editor>`		link

Contributing

Clone and setup the repo:

git clone https://github.com/pixano/pixano-elements.git
cd pixano-elements
npm i
npm run bootstrap
npm run build

To run the demos locally, serve one of the demo folders:

npx serve demos/rectangle

Getting started

To create a new component, check our tutorial.

Please follow our coding guidelines for your contributions.

Change log

Releases

License

Pixano is released under the CeCILL-C license, a free software license adapted to both international and French legal matters that is fully compatible with the FSF's GNU/LGPL license.