🚀 Planka Client

A simple client for Planka generated from its OpenAPI specification using openapi-ts.

See PlankAPI for an implementation using this client.

Installation

Add the following dependency to your package.json:

npm install @gewis/planka-client

or using Yarn:

yarn add @gewis/planka-client

📦 Usage

Import the desired service and call the required endpoint. Check out Heyapi for more details.

import { client, authorize } from '@gewis/planka-client';

client.setConfig({
  baseUrl: 'https://example.com',
});

/** Fetch access token with `authorize` or `authorizeOidc` */
const accessToken = authorize(...);

client.setConfig({
  baseUrl: 'https://example.com',
  headers: {
    Authorization: `Bearer ${accessToken}`
  }
});

🧪 Testing

1. Start Planka with:

docker compose up -d

2. Run tests:

yarn test

📄 License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

🌟 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.