{"id":13640823,"url":"https://github.com/pinussilvestrus/postit-js","last_synced_at":"2025-04-04T19:15:02.708Z","repository":{"id":38827175,"uuid":"253807782","full_name":"pinussilvestrus/postit-js","owner":"pinussilvestrus","description":"Create post-it boards - built with diagram-js","archived":false,"fork":false,"pushed_at":"2025-02-27T23:40:44.000Z","size":5154,"stargazers_count":86,"open_issues_count":19,"forks_count":27,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-28T18:11:36.815Z","etag":null,"topics":["brainstorming","diagram-js","javascript","post-it","postit-js","sticky-notes"],"latest_commit_sha":null,"homepage":"https://postit-js-demo.netlify.app/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pinussilvestrus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-07T13:52:11.000Z","updated_at":"2024-12-17T18:48:14.000Z","dependencies_parsed_at":"2023-02-19T03:00:44.721Z","dependency_job_id":"10b68c65-9a9e-4202-b0b0-cedff7a2efc7","html_url":"https://github.com/pinussilvestrus/postit-js","commit_stats":{"total_commits":190,"total_committers":5,"mean_commits":38.0,"dds":"0.16315789473684206","last_synced_commit":"6869e3d260f9c5925d83ea57d8cefabaaaa88e81"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinussilvestrus%2Fpostit-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinussilvestrus%2Fpostit-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinussilvestrus%2Fpostit-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinussilvestrus%2Fpostit-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pinussilvestrus","download_url":"https://codeload.github.com/pinussilvestrus/postit-js/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247234923,"owners_count":20905854,"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","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":["brainstorming","diagram-js","javascript","post-it","postit-js","sticky-notes"],"created_at":"2024-08-02T01:01:14.738Z","updated_at":"2025-04-04T19:15:02.688Z","avatar_url":"https://github.com/pinussilvestrus.png","language":"JavaScript","funding_links":[],"categories":["Apps"],"sub_categories":[],"readme":"# postit-js\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/72130b1d-f56b-473e-8f3b-50a5af916e64/deploy-status)](https://app.netlify.com/sites/postit-js-demo/deploys) ![Build Status](https://github.com/pinussilvestrus/postit-js/workflows/ci/badge.svg)\n\n\nCreate post-it brainstorming boards - built with [diagram-js](https://github.com/bpmn-io/diagram-js).\n\n![Screencast](./docs/screencast.gif)\n\nCheckout the [**Demo**](https://postit-js-demo.netlify.app/) or the [**Experiments Page**](https://postit-js-experiments.netlify.app/) to get some inspiration.\n\n## Features\n\n* Create resizable Post-its on the Canvas (squared and circled) via\n  * Palette\n  * Double Click (latest element type will be respected)\n* Change the color of Post-its\n* Create simple Text Boxes on the Canvas\n* Create grouping frame elements on the Canvas\n* Add external image resources on the Canvas\n\n## Installation\n\nInstall the package to include it into your web application\n\n```sh\n$ npm install postit-js-core --save\n```\n\n## Usage\n\nTo get started, create a [postit-js](https://github.com/pinussilvestrus/postit-js) instance\nand render a post-it board into your web application\n\n```javascript\nimport 'postit-js-core/assets/postit-js.css';\n\nimport PostItModeler from 'postit-js-core/lib/Modeler';\n\nlet xml; // my post-it xml \n\nconst modeler = new PostItModeler({\n  container: '#canvas',\n  keyboard: {\n    bindTo: window,\n  }\n});\n\nmodeler.importXML(xml).then(function() {\n  console.log('board rendered');\n}).catch(function(error) {\n  console.error('could not import postit board', err);\n});\n```\n\nFor using `postit-js` inside your web application you'll need a source code bundler, e.g. [webpack](https://webpack.js.org/). Checkout the [example](./example) for getting inspiration. \n\n### Development Setup\n\nSpin up the application for development, all strings attached:\n\n```sh\n$ npm install\n$ cd  example\n$ npm install\n$ npm run dev\n```\n\n## Extensions\n\nSince [`diagram-js`](https://github.com/bpmn-io/diagram-js) and also this project is extendable by design, there exist a couple of great community maintained extensions\n\n* [`drag-drop-images`](https://github.com/xanpj/postit-js-extensions#drag-drop-images) - Drag and drop image files on the board\n* [`selection-organizer`](https://github.com/xanpj/postit-js-extensions#selection-organizer) - Organize and distribute groups of elements\n* [`properties-panel`](https://github.com/xanpj/postit-js-extensions#properties-panel) - Properties panel for post-it elements\n\n## License\n\nMIT\n\nContains parts of ([bpmn-io](https://github.com/bpmn-io)) released under the [bpmn.io license](http://bpmn.io/license).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinussilvestrus%2Fpostit-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpinussilvestrus%2Fpostit-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinussilvestrus%2Fpostit-js/lists"}