Unofficial Node.js API client for Cinode.
🚧 This client is still very much in development and might change drastically 🚧
This client has support for:
- Interacting with skills
- Interacting with project assignments
- More to follow...
npm install --save @polarsquad/cinode-api
Enable the Cinode REST API for your company (docs)
Create a Cinode user and give it the roles "Api" and "Manager" in https://app.cinode.com/polarsquad/administration/users/employees/
- The
yourcompanypart of the URL is your company name in the configuration
- The
Create a Cinode token for the bot user in https://app.cinode.com/polarsquad/administration/integrations/tokens
- Name & expiration: anything you like
- Mimic user: your bot user
- Token claims: Manager & Admin
Import and configure the client:
import{Api}from'@polarsquad/cinode-api/api'importclientBuilderfrom'@polarsquad/cinode-api/client'import{CinodeService}from'@polarsquad/cinode-api/service'constapi=newApi({id: 1234,// Company IDname: 'yourcompany'// Company name},clientBuilder('cinodeapitoken',// Cinode API token))constservice=newCinodeService(api)
🚀 Run tests: npm run test
🔧 Lint code: npm run lint-fix
🖌️ Autoformat code: npm run prettier-fix
- Create new branch
- Update version in
package.jsonbased on changes (we follow semantic versioning) - Run
npm installto updatepackage-lock.json - Create Pull Request with title "Release x.y.z" and description for changelog
- Merge changes to
main - Tag & release with the format "vX.Y.Z" (e.g.
0.3.0inpackage.jsonbecomesv0.3.0as tag title) - GitHub Actions publishes the version in npm
See LICENSE for more details.