https://github.com/postiva/postiva-client

The @postiva/client is a simple and easy to use SDK for Postiva API. It provides a set of methods to interact with the API and it's built with Typescript.
https://github.com/postiva/postiva-client

cms headless headless-cms next-cms nuxt-cms open-source post postiva react saas sdk solid vue

Last synced: about 2 months ago
JSON representation

The @postiva/client is a simple and easy to use SDK for Postiva API. It provides a set of methods to interact with the API and it's built with Typescript.

• Host: GitHub
• URL: https://github.com/postiva/postiva-client
• Owner: postiva
• License: mit
• Created: 2024-02-18T22:22:42.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-08-10T21:29:46.000Z (5 months ago)
• Last Synced: 2024-08-10T22:26:20.320Z (5 months ago)
• Topics: cms, headless, headless-cms, next-cms, nuxt-cms, open-source, post, postiva, react, saas, sdk, solid, vue
• Language: TypeScript
• Homepage: https://docs.postiva.app/
• Size: 1.27 MB
• Stars: 14
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @postiva/client

Easily manage and retrieve content within your applications with @postiva/client, a powerful library that simplifies interactions with the Postiva platform. Keep your content up-to-date and accessible with our simple API.

For detailed API documentation and more examples, visit our [official documentation](https://docs.postiva.app/).

[![npm version](https://badge.fury.io/js/%40postiva%2Fclient.svg)](https://badge.fury.io/js/%40postiva%2Fclient)

[![GitHub license](https://img.shields.io/github/license/postiva/client)](https://github.com/postiva/postiva-js/blob/main/LICENSE)

## Features

- **Effortless Content Management**: Seamlessly fetch and manage content within your application.

- **Pagination Support**: Handle large datasets effectively with built-in pagination support.

- **REST API Support**: Integrate your blog seamlessly into any tech stack with REST API support.

- **TypeScript Support**: Enjoy type safety and autocompletion with TypeScript support.

- **Statistics**: Get insights into your content's performance and engagement. (views, claps, likes)

## Installation

You can install `@postiva/client` via npm, yarn, or pnpm:

```bash

npm install @postiva/client

```

## Usage

To start using `@postiva/client` in your project, initialize the client by providing your workspace ID and API key:

```js

import { createClient } = from "@postiva/client"

// Initialize Postiva Client

const client = createClient({

  workspaceId: "yourWorkspaceId",

  apiKey: "yourApiKey",

});

```

### Rest API Documentation

The REST API documentation for `@postiva/client` has been automatically generated by Bruno. Please refer to **REST API Documentation** for details.

## Contributing

Contributions to `@postiva/client` are welcome! If you have ideas for improvements, found a bug, or want to contribute new features, please check out our contribution guidelines and code of conduct before opening an issue or submitting a pull request.

# Contributors

Thank you for your contributions! We appreciate all the contributions from the community.



  



## License

`@postiva/client` is available under the MIT License. For more details, see the [LICENSE](https://github.com/postiva/postiva-client/blob/main/LICENSE) file.