Pixano Elements - Library of web components dedicated to data annotation tasks. A complete and ready-to-use annotation application is available at https://github.com/pixano/pixano-app.
IMPORTANT: The Pixano Web Components are a work in progress and subject to major changes until 1.0 release.
Playcode demo (interactive-segmentation, cuboid, rectangle, smart-rectangle)
Automatic build tests on Ubuntu (latest) and node version 10, 12, 14.
Pixano requires WebGL to be activated in your browser. If you see the following error in you console WebGL unsupported in this browser, please activate it.
For development, you will only need Node.js installed in your environement.
-
Just go on official Node.js website and download the installer. Also, be sure to have
gitavailable in your PATH,npmmight need it (You can find git here). -
You can install nodejs and npm easily with apt install, just run the following commands.
sudo apt install nodejs sudo apt install npm
Or install it with snap:
sudo snap install node -
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.0git clone https://github.com/pixano/pixano-elements.git
cd pixano-elements/demos/rectangle
npm i
npx serve
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.
| Component | Status | Demo |
|---|---|---|
<pxn-rectangle> |
|
demo |
<pxn-polygon> |
|
demo |
<pxn-segmentation> |
|
demo |
<pxn-graph> |
|
demo |
<pxn-smart-rectangle> |
|
demo |
<pxn-cuboid-editor> |
 |
demo |
📚 Check out the TypeDoc documentation. Each package's usage and API is also documented:
You can also try the demos on our website.
Clone and setup the repo:
git clone https://github.com/pixano/pixano-elements.git
cd pixano-elements
npm i
npm run bootstrap
npm run buildTo run the demos locally, serve one of the demo folders:
npx serve demos/rectangleTo create a new component, check our tutorial.
Please follow our coding guidelines for your contributions.
# Fork the repo from the upstream remote repo to your personal github
# Then clone the repo into local machine to work locally and do some changes
# Then configure the git remote for the fork
git remote add upstream [email protected]:pixano/pixano-elements.git
# Important: sync your local forked repo with the remote repo
# Or use cherry-pick if you want to make sure to not include some internal commits
git pull upstream master
# Merge the changes from upstream/master into your local master branch
git checkout master
git merge upstream/master
# Then in the browser navigate to the original URL of the original pixano-elements repo
# Click on “Create Pull Request”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.