{"id":27555904,"url":"https://github.com/polarsquad/cinode-api","last_synced_at":"2025-04-19T17:55:44.352Z","repository":{"id":42330549,"uuid":"442412607","full_name":"polarsquad/cinode-api","owner":"polarsquad","description":"Unofficial Node.js API client for Cinode","archived":false,"fork":false,"pushed_at":"2024-06-18T19:59:40.000Z","size":1013,"stargazers_count":3,"open_issues_count":6,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-19T11:19:13.587Z","etag":null,"topics":["api","cinode","client","javascript","node","node-js","nodejs","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/polarsquad.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2021-12-28T09:23:28.000Z","updated_at":"2023-03-02T10:02:39.000Z","dependencies_parsed_at":"2023-09-24T07:18:53.436Z","dependency_job_id":"3be547e0-fbec-48b5-a024-31b1529f1a8b","html_url":"https://github.com/polarsquad/cinode-api","commit_stats":{"total_commits":136,"total_committers":5,"mean_commits":27.2,"dds":0.5588235294117647,"last_synced_commit":"aa0498a6d421b0507ee09193f3233c6dc14e7042"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polarsquad%2Fcinode-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polarsquad%2Fcinode-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polarsquad%2Fcinode-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polarsquad%2Fcinode-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/polarsquad","download_url":"https://codeload.github.com/polarsquad/cinode-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249754143,"owners_count":21320732,"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":["api","cinode","client","javascript","node","node-js","nodejs","typescript"],"created_at":"2025-04-19T17:55:43.946Z","updated_at":"2025-04-19T17:55:44.341Z","avatar_url":"https://github.com/polarsquad.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @polarsquad/cinode-api\n\n**Unofficial** Node.js API client for [Cinode](https://cinode.com).\n\n\u003e 🚧 This client is still very much in development and might change drastically 🚧\n\nThis client has support for:\n\n- Interacting with skills\n- Interacting with project assignments\n- _More to follow..._\n\n## Installation\n\n`npm install --save @polarsquad/cinode-api`\n\n## Configuration\n\n1. Enable the Cinode REST API for your company ([docs](https://support.cinode.com/en/articles/3994666-cinode-rest-api))\n1. Create a Cinode user and give it the roles \"Api\" and \"Manager\" in \u003chttps://app.cinode.com/polarsquad/administration/users/employees/\u003e\n    - The `yourcompany` part of the URL is your company name in the configuration\n1. Create a Cinode token for the bot user in \u003chttps://app.cinode.com/polarsquad/administration/integrations/tokens\u003e\n    - Name \u0026 expiration: anything you like\n    - Mimic user: your bot user\n    - Token claims: Manager \u0026 Admin\n1. Import and configure the client:\n\n    ```typescript\n    import { Api } from '@polarsquad/cinode-api/api'\n    import clientBuilder from '@polarsquad/cinode-api/client'\n    import { CinodeService } from '@polarsquad/cinode-api/service'\n\n    const api = new Api(\n      {\n        id: 1234,               // Company ID\n        name: 'yourcompany'     // Company name\n      },\n      clientBuilder(\n        'cinodeapitoken',       // Cinode API token\n      )\n    )\n    const service = new CinodeService(api)\n    ```\n\n## Development\n\n### Useful commands\n\n🚀 Run tests: `npm run test`\n\n🔧 Lint code: `npm run lint-fix`\n\n🖌️ Autoformat code: `npm run prettier-fix`\n\n### Releasing\n\n1. Create new branch\n1. Update version in `package.json` based on changes (we follow [semantic versioning](https://semver.org/))\n1. Run `npm install` to update `package-lock.json`\n1. Create Pull Request with title \"Release x.y.z\" and description for changelog\n1. Merge changes to `main`\n1. Tag \u0026 release with the format \"vX.Y.Z\" (e.g. `0.3.0` in `package.json` becomes `v0.3.0` as tag title)\n1. GitHub Actions publishes the version in npm\n\n## Links\n\n- [Official Cinode API documentation](https://api.cinode.app/docs/index.html)\n\n## License\n\nSee [LICENSE](./LICENSE) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolarsquad%2Fcinode-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpolarsquad%2Fcinode-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolarsquad%2Fcinode-api/lists"}