https://github.com/polarsquad/cinode-api
Unofficial Node.js API client for Cinode
https://github.com/polarsquad/cinode-api
api cinode client javascript node node-js nodejs typescript
Last synced: about 1 year ago
JSON representation
Unofficial Node.js API client for Cinode
- Host: GitHub
- URL: https://github.com/polarsquad/cinode-api
- Owner: polarsquad
- License: mit
- Created: 2021-12-28T09:23:28.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T19:59:40.000Z (almost 2 years ago)
- Last Synced: 2025-03-19T11:19:13.587Z (about 1 year ago)
- Topics: api, cinode, client, javascript, node, node-js, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 989 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @polarsquad/cinode-api
**Unofficial** Node.js API client for [Cinode](https://cinode.com).
> 🚧 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..._
## Installation
`npm install --save @polarsquad/cinode-api`
## Configuration
1. Enable the Cinode REST API for your company ([docs](https://support.cinode.com/en/articles/3994666-cinode-rest-api))
1. Create a Cinode user and give it the roles "Api" and "Manager" in
- The `yourcompany` part of the URL is your company name in the configuration
1. Create a Cinode token for the bot user in
- Name & expiration: anything you like
- Mimic user: your bot user
- Token claims: Manager & Admin
1. Import and configure the client:
```typescript
import { Api } from '@polarsquad/cinode-api/api'
import clientBuilder from '@polarsquad/cinode-api/client'
import { CinodeService } from '@polarsquad/cinode-api/service'
const api = new Api(
{
id: 1234, // Company ID
name: 'yourcompany' // Company name
},
clientBuilder(
'cinodeapitoken', // Cinode API token
)
)
const service = new CinodeService(api)
```
## Development
### Useful commands
🚀 Run tests: `npm run test`
🔧 Lint code: `npm run lint-fix`
🖌️ Autoformat code: `npm run prettier-fix`
### Releasing
1. Create new branch
1. Update version in `package.json` based on changes (we follow [semantic versioning](https://semver.org/))
1. Run `npm install` to update `package-lock.json`
1. Create Pull Request with title "Release x.y.z" and description for changelog
1. Merge changes to `main`
1. Tag & release with the format "vX.Y.Z" (e.g. `0.3.0` in `package.json` becomes `v0.3.0` as tag title)
1. GitHub Actions publishes the version in npm
## Links
- [Official Cinode API documentation](https://api.cinode.app/docs/index.html)
## License
See [LICENSE](./LICENSE) for more details.