{"id":17070579,"url":"https://github.com/oakmac/chessboard2","last_synced_at":"2025-08-22T00:31:56.338Z","repository":{"id":61345174,"uuid":"356680643","full_name":"oakmac/chessboard2","owner":"oakmac","description":"chessboard.js v2","archived":false,"fork":false,"pushed_at":"2024-02-17T15:30:04.000Z","size":844,"stargazers_count":69,"open_issues_count":33,"forks_count":3,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-04-14T12:55:28.192Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Clojure","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oakmac.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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":"2021-04-10T19:55:39.000Z","updated_at":"2024-04-10T21:34:50.000Z","dependencies_parsed_at":"2024-10-14T11:32:31.751Z","dependency_job_id":"b0b46db2-e4ad-410f-8284-07a493bf5d42","html_url":"https://github.com/oakmac/chessboard2","commit_stats":{"total_commits":172,"total_committers":3,"mean_commits":"57.333333333333336","dds":"0.029069767441860517","last_synced_commit":"e0f67a9f9f7465e03596803bebde2449ce00c930"},"previous_names":["oakmac/chessboardjs2"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oakmac%2Fchessboard2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oakmac%2Fchessboard2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oakmac%2Fchessboard2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oakmac%2Fchessboard2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oakmac","download_url":"https://codeload.github.com/oakmac/chessboard2/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230542288,"owners_count":18242332,"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":[],"created_at":"2024-10-14T11:32:22.543Z","updated_at":"2024-12-20T06:06:58.860Z","avatar_url":"https://github.com/oakmac.png","language":"Clojure","funding_links":[],"categories":[],"sub_categories":[],"readme":"# chessboard2 JavaScript Library [![npm](https://img.shields.io/npm/v/@chrisoakman/chessboard2)](https://www.npmjs.com/package/@chrisoakman/chessboard2) [![ISC License](https://img.shields.io/npm/l/@chrisoakman/chessboard2)](https://github.com/oakmac/chessboard2/blob/master/LICENSE.md)\n\nAn updated version of [chessboard.js].\n\n- better mobile support\n- no dependencies\n- written in [ClojureScript]\n- improved API\n\n## Development Status\n\n**April 2023**: Development in progress. Getting close to an initial v2 release. Pretty usable for most projects in it's current state.\n\nIn-progress documentation available at [https://chessboardjs.com/v2/examples](https://chessboardjs.com/v2/examples)\n\n## Download and Install\n\nInstructions are available [here](https://chessboardjs.com/v2/download).\n\n[@chrisoakman/chessboard2 on npm](https://www.npmjs.com/package/@chrisoakman/chessboard2)\n\nOr use via [CDN](https://en.wikipedia.org/wiki/Content_delivery_network):\n\n```html\n\u003c!-- add stylesheet via CDN: --\u003e\n\u003clink rel=\"stylesheet\"\n      href=\"https://unpkg.com/@chrisoakman/chessboard2@0.5.0/dist/chessboard2.min.css\"\n      integrity=\"sha384-47VeTDpmy4yT21gKPXQcLQYQZwlmz27gEH5NTrOmTk3G/SGvMyltclOW/Q8uE+sL\"\n      crossorigin=\"anonymous\"\u003e\n\n\u003c!-- add JS via CDN: --\u003e\n\u003cscript src=\"https://unpkg.com/@chrisoakman/chessboard2@0.5.0/dist/chessboard2.min.js\"\n        integrity=\"sha384-/KwQCjA1GWovZNV3QDVtvSMDzO4reGgarF/RqHipr7hIUElH3r5zNl9WEPPOBRIF\"\n        crossorigin=\"anonymous\"\u003e\u003c/script\u003e\n```\n\n## Naming and Versioning\n\nchessboard2 is a distinct project from [chessboard.js]. The project name is\n\"chessboard2\" and the version of the library will be independent of the version\nof original [chessboard.js].\n\nTo remove any confusion for users, I will release chessboard2 at v2.0.0 for it's\n\"initial release\". There will not be a v1.0.0 major release of chessboard2.\n\nIt is possible (although unlikely) that chessboard.js will have a v2.0.0 branch.\n\n## Development Setup\n\nMake sure that [node.js], [yarn], and a modern version of the JVM are installed (for [shadow-cljs]), then:\n\n[node.js]:https://nodejs.org\n[yarn]:https://yarnpkg.com/\n[shadow-cljs]:https://github.com/thheller/shadow-cljs\n\n```sh\n## initial setup: install node_modules/ folder\nyarn install\n\n## produce website/chessboard2.js and build the local website\nnpm run build\n\n## run a local web server on port 3232\nnpm run local-dev\n```\n\nIn order to create and publish a release:\n\n```sh\n## 1) update CHANGELOG\n## 2) make sure flags/runtime-checks? is set to false\n## 3) update package.json version\n## 4) create a git commit\n## 5) create git tag: \"git tag -a v1.4 -m \"my version 1.4\" \"\n## 6) push git tag to GitHub: git push origin \u003ctagname\u003e\n\n## 7) create fresh build\nnpm run release\n\n## 8) sanity-check the result files\nnpm publish --dry-run\n\n## 9) publish\nnpm publish --access=public\n```\n\n## Tests\n\n```sh\n## Unit Tests\nnpm run test\n\n## Cypress\nnpm run cypress\n```\n\n## TODO before go-live\n\n- [ ] variadic `removeArrow`, `removeCircle`, `removePiece` functions\n- [ ] add \"Rings\"\n  - are these separate from Circles or just an added config value?\n- [ ] custom Items\n  - add Duck to board, add toaster SVG\n- [ ] version the position? increment by 1 every time the position changes\n- [ ] review the speed shorthand times. ie: what should \"slow\" and \"superslow\" feel like?\n\n## API\n\n- `getItems()` return all items\n- \"pulse\" a piece with some simple animations\n- \"bounce\" a piece?\n- animate an arrow\n- `removeArrow(\u003carrowId\u003e, \u003carrowId\u003e, etc)`\n\n## License\n\n[ISC License](LICENSE.md)\n\n[ClojureScript]:https://clojurescript.org/\n[chessboard.js]:https://github.com/oakmac/chessboardjs\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foakmac%2Fchessboard2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foakmac%2Fchessboard2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foakmac%2Fchessboard2/lists"}