{"id":13805686,"url":"https://github.com/pixano/pixano-elements","last_synced_at":"2025-08-11T15:06:32.994Z","repository":{"id":37904846,"uuid":"227900524","full_name":"pixano/pixano-elements","owner":"pixano","description":"Pixano Elements - Re-usable web components dedicated to data annotation tasks.","archived":false,"fork":false,"pushed_at":"2023-03-22T13:34:00.000Z","size":11241,"stargazers_count":41,"open_issues_count":4,"forks_count":16,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-08-08T21:04:08.362Z","etag":null,"topics":["annotation","annotation-tool","annotations","bounding-box","computer-vision","cuboid","deep-learning","detection","image-annotation","image-labeling","instance-segmentation","keypoints","panoptic-segmentation","point-cloud","point-cloud-labeling","polygon","semantic-segmentation","video-annotation","video-labeling","web-components"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pixano.png","metadata":{"files":{"readme":"README.md","changelog":"changeversion.js","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-12-13T18:35:50.000Z","updated_at":"2025-05-09T08:47:43.000Z","dependencies_parsed_at":"2022-08-18T13:11:17.972Z","dependency_job_id":null,"html_url":"https://github.com/pixano/pixano-elements","commit_stats":{"total_commits":321,"total_committers":11,"mean_commits":"29.181818181818183","dds":0.5420560747663552,"last_synced_commit":"3d6f328a3219c03c6eb312e7e59d8aa77be57b4b"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"purl":"pkg:github/pixano/pixano-elements","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixano%2Fpixano-elements","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixano%2Fpixano-elements/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixano%2Fpixano-elements/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixano%2Fpixano-elements/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pixano","download_url":"https://codeload.github.com/pixano/pixano-elements/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixano%2Fpixano-elements/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269658771,"owners_count":24455074,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-09T02:00:10.424Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["annotation","annotation-tool","annotations","bounding-box","computer-vision","cuboid","deep-learning","detection","image-annotation","image-labeling","instance-segmentation","keypoints","panoptic-segmentation","point-cloud","point-cloud-labeling","polygon","semantic-segmentation","video-annotation","video-labeling","web-components"],"created_at":"2024-08-04T01:01:03.867Z","updated_at":"2025-08-11T15:06:32.934Z","avatar_url":"https://github.com/pixano.png","language":"TypeScript","funding_links":[],"categories":["Real World","TypeScript"],"sub_categories":["Component Libraries"],"readme":"# \u003cimg src=\"images/pixano_logo.png\" alt=\"Pixano\" height=\"100\"/\u003e\n\n[![License](https://img.shields.io/badge/license-CeCILL--C-blue.svg)](LICENSE)\n[![Live Demo](https://img.shields.io/badge/demo-online-green.svg)](https://pixano.github.io/demo/demo)\n[![Published on npm](https://img.shields.io/npm/v/@pixano/graphics-2d.svg)](https://www.npmjs.com/package/@pixano/graphics-2d)\n\u003c!--[![Node.js CI](https://github.com/pixano/pixano-elements/workflows/Node.js%20CI/badge.svg)](https://github.com/pixano/pixano-elements/workflows/Node.js%20CI/badge.svg)--\u003e\n\n## What is PIXANO ?\n[Pixano](https://pixano.cea.fr/) is a web-based smart-annotation tool for computer vision applications. The modules are driven by artificial intelligence, which assists the human user with annotation tasks and accelerate the annotation process. Try some of our features [online](https://pixano.github.io/demo/demo.html)!\n\n![pixano.gif](https://raw.githubusercontent.com/pixano/pixano-app/master/documentation/pixano.gif)\n\n\nPixano Elements\n===============\n\nPixano Elements - Library of web components dedicated to data annotation tasks.\n\n[![Alt text](http://i3.ytimg.com/vi/z5T2HhnugJo/maxresdefault.jpg)](https://www.youtube.com/watch?v=z5T2HhnugJo)\n\nHave a look to our [online demos](https://pixano.github.io/demo/demo) !\n\nBeside Pixano elements, a complete and ready-to-use annotation application is available at `https://github.com/pixano/pixano-app`.\n\n\u003e IMPORTANT: The Pixano Web Components are a work in progress and subject to major changes until 1.0 release.\n\nAutomatic build tests on Ubuntu (latest) and node version 10, 12, 14.\u003c!-- TODO: is it still true ? =\u003e verify --\u003e\n\n\n## Table of content\n  * [Components overview](#components-overview)\n  * [Requirements](#requirements)\n  * [Build and run the overall demo](#build-and-run-the-overall-demo)\n  * [Documentation](#documentation)\n  * [How to contribute ?](#how-to-contribute-)\n    + [Getting started](#getting-started)\n    + [First time](#first-time)\n      + [Fork and clone](#fork-and-clone)\n      + [First run](#first-run)\n    + [Modify and test the code](#modify-and-test-the-code)\n    + [Create a pull request](#create-a-pull-request)\n  * [Change log](#change-log)\n  * [License](#license)\n\n\n## Components overview\n\nThe Pixano Elements are divided into `packages`. Each package can be installed independantly from [NPM](https://www.npmjs.com/) using the following command:\n\n```\nnpm install @pixano/graphics-2d\n```\n\nEach package can contain multiple web components which are grouped by affinity.\n\n\n| Component | Status | Demo |\n| ----------| -------| -----|\n| [`\u003cpxn-classification\u003e`](https://github.com/pixano/pixano-elements/blob/master/packages/graphics-2d) | [![Published on npm](https://img.shields.io/npm/v/@pixano/graphics-2d.svg)](https://www.npmjs.com/package/@pixano/graphics-2d) | [demo](http://pixano.cea.fr/classification/) |\u003c!-- TODO --\u003e\n| [`\u003cpxn-rectangle\u003e`](https://github.com/pixano/pixano-elements/blob/master/packages/graphics-2d) | [![Published on npm](https://img.shields.io/npm/v/@pixano/graphics-2d.svg)](https://www.npmjs.com/package/@pixano/graphics-2d) | [demo](http://pixano.cea.fr/bounding-box/) |\n| [`\u003cpxn-polygon\u003e`](https://github.com/pixano/pixano-elements/blob/master/packages/graphics-2d) |  [![Published on npm](https://img.shields.io/npm/v/@pixano/graphics-2d.svg)](https://www.npmjs.com/package/@pixano/graphics-2d) | [demo](http://pixano.cea.fr/polygon/) |\n| [`\u003cpxn-segmentation\u003e`](https://github.com/pixano/pixano-elements/blob/master/packages/graphics-2d) | [![Published on npm](https://img.shields.io/npm/v/@pixano/graphics-2d.svg)](https://www.npmjs.com/package/@pixano/graphics-2d) | [demo](http://pixano.cea.fr/pixelwise/) |\n| [`\u003cpxn-keypoints\u003e`](https://github.com/pixano/pixano-elements/blob/master/packages/graphics-2d) | [![Published on npm](https://img.shields.io/npm/v/@pixano/graphics-2d.svg)](https://www.npmjs.com/package/@pixano/graphics-2d) | [demo](http://pixano.cea.fr/keypoint/) |\n| [`\u003cpxn-tracking\u003e`](https://github.com/pixano/pixano-elements/blob/master/packages/graphics-2d) | [![Published on npm](https://img.shields.io/npm/v/@pixano/graphics-2d.svg)](https://www.npmjs.com/package/@pixano/graphics-2d) | [demo](http://pixano.cea.fr/tracking/) |\u003c!-- TODO --\u003e\n| [`\u003cpxn-tracking-graph\u003e`](https://github.com/pixano/pixano-elements/blob/master/packages/graphics-2d) | [![Published on npm](https://img.shields.io/npm/v/@pixano/graphics-2d.svg)](https://www.npmjs.com/package/@pixano/graphics-2d) | [demo](http://pixano.cea.fr/tracking-graph/) |\u003c!-- TODO --\u003e\n| [`\u003cpxn-smart-rectangle\u003e`](https://github.com/pixano/pixano-elements/blob/master/packages/graphics-2d) | [![Published on npm](https://img.shields.io/npm/v/@pixano/graphics-2d.svg)](https://www.npmjs.com/package/@pixano/graphics-2d) | [demo](http://pixano.cea.fr/smart-annotation/) |\n| [`\u003cpxn-smart-segmentation\u003e`](https://github.com/pixano/pixano-elements/blob/master/packages/graphics-2d) | [![Published on npm](https://img.shields.io/npm/v/@pixano/graphics-2d.svg)](https://www.npmjs.com/package/@pixano/graphics-2d) | [demo](http://pixano.cea.fr/smart-segmentation/) |\u003c!-- TODO --\u003e\n| [`\u003cpxn-smart-tracking\u003e`](https://github.com/pixano/pixano-elements/blob/master/packages/graphics-2d) | [![Published on npm](https://img.shields.io/npm/v/@pixano/graphics-2d.svg)](https://www.npmjs.com/package/@pixano/graphics-2d) | [demo](http://pixano.cea.fr/smart-tracking/) |\u003c!-- TODO --\u003e\n| [`\u003cpxn-cuboid-editor\u003e`](https://github.com/pixano/pixano-elements/blob/master/packages/graphics-3d) | [![Published on npm](https://img.shields.io/npm/v/@pixano/graphics-3d.svg)](https://www.npmjs.com/package/@pixano/graphics-3d) | [demo](http://pixano.cea.fr/3d-bounding-box/) |\n\n\n\n## Requirements\n\nPixano requires WebGL to be activated in your browser. If you see the following error in you console `WebGL unsupported in this browser`, please [activate](https://superuser.com/questions/836832/how-can-i-enable-webgl-in-my-browser) it.\n\nFor development, you will only need Node.js installed in your environement.\n\nFor a fresh install, please follow our guide to install it on your system:\n- [Node installation on Windows](./INSTALL.md#windows)\n- [Node installation on Ubuntu](./INSTALL.md#linux)\n\nIf the installation was successful, you should be able to run the following command:\n```bash\nnode --version\n# v10.19.0\n\nnpm --version\n# 6.10.0\n```\n\n## Build and run the overall demo\nAn online serverless demo is available on our dedicated [website](https://pixano.github.io/demo/demo).\n\nIf you want to build the latests version, it's easy:\n```\ngit clone https://github.com/pixano/pixano-elements.git\ncd pixano-elements\nnpm run deps\nnpm run build\nnpx serve demo\n```\n\n## Documentation\n\n📚 Check out the [TypeDoc](https://pixano.github.io/docs/docs) documentation. Each package's usage and API is also documented:\n\n- [graphics-2d](https://github.com/pixano/pixano-elements/blob/master/packages/graphics-2d)\n- [graphics-3d](https://github.com/pixano/pixano-elements/blob/master/packages/graphics-2d)\n\n\nYou can also try the demos on our [website](http://pixano.cea.fr/bounding-box/).\n\n\n## How to contribute ?\n\n### Getting started\n\nTo create a new component, check our [tutorial](./documentation/how_to_create_a_new_component.md).\n\nPlease follow our [coding guidelines](./documentation/coding_guidelines.md) for your contributions.\n\n#### About the contribution process\n\nThe contribution process follows this well-known diagram :\n\n![diagram-pull-request.png](documentation/diagram-pull-request.png)\n\n### First time:\n#### Fork and clone\n\n1. Fork this project\n\n\t*Click on the Fork button*\n\t\n2. Clone the fork on your local machine\n```bash\n\tgit clone git@github.com:$YOURLOGIN/pixano-elements.git\n\t# OR\n\tgit clone https://github.com/$YOURLOGIN/pixano-elements.git\n\t# go to code\n\tcd pixano-elements\n```\n3. Add the original repository as a remote called upstream\n```bash\n\tgit remote add upstream git@github.com:pixano/pixano-elements.git\n\t# OR\n\tgit remote add upstream https://github.com/pixano/pixano-elements.git\n```\n\n#### First run\n4. Install dependencies and build the project\n```bash\ncd pixano-elements\nnpm run deps\nnpm run build\n```\n\n5. Run the demo locally:\n\n```bash\nnpx serve demo\n```\n\n\n### Modify and test the code\n\n1. Check that you are on the right branch and pull upstream changes into your local repository if necessary\n```bash\n\tgit checkout master\n\tgit pull upstream master\n\t#If needed: merge\n\t#If needed: git push origin master\n```\n2. Create a new branch to work on\n```bash\n\tgit checkout -b $MY_BRANCH_NAME\n```\n3. Implement/fix your feature, comment your code.\n\n4. Test your modifications locally using the serverless-demo\n```bash\n\tnpm run build\n\tnpx serve demo\n```\n*This demo takes your local modifications into account, thanks to a bootstrap step.*\n\n\nIf you modified the dependencies, you better clean the project before rebuilding:\n\n```bash\n\tnpm run clearall\n\tnpm run deps\n\tnpm run build\n\tnpx serve demo\n```\n\n### Create a pull request\n\n5. Add or change the documentation as needed.\n6. Commit your modifications using meaningfull comments.\n7. Push your branch to your fork\n```bash\n\tgit push origin $MY_BRANCH_NAME\n```\n8. On github, open a pull request from your fork in the correct branch.\n\n\t*A green button \"Compare \u0026 pull request\" should appear. If not, click on branches button (https://github.com/$YOURLOGIN/pixano-elements/branches) and then click the \"New pull request\" button corresponding to your contribution branch.*\n\n9. Complete the merge request message with a meaningfull title and a comprehensive comment: describe how your work is changing Pixano and what modules are impacted. You could use something like:\n```\n\t## pxn-$IMPACTED_PLUGIN\n\t* file: modifications...\n\t* file: modifications...\n\t* ...\n\t## pxn-$OTHER_IMPACTED_PLUGIN\n\t* ...\n\n\tCo-authored-by: ...\n```\n\n10. click on \"Create pull request\" =\u003e automatic verifications are made by github\n\nNice work ! Thank you for contributing to Pixano !\n\n\n\n## Change log\n\n[Releases](https://github.com/pixano/pixano-elements/releases)\n\n## License\n\nPixano is released under the [CeCILL-C](LICENSE.txt) license, a free software license\n adapted to both international and French legal matters that is fully compatible\n with the FSF's GNU/LGPL license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixano%2Fpixano-elements","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpixano%2Fpixano-elements","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixano%2Fpixano-elements/lists"}