npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@yoast/ai-frontend

v0.14.0

Published

The frontend for Yoast AI features

Downloads

340

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

yoastbotyoastbotigorschoesterigorschoesterdeepthoughtyoastdeepthoughtyoastdennisatyoastdennisatyoastfamarfuatyfamarfuatymhkuumhkuujo_pvjo_pv

Keywords

Readme

CI Pipeline Coverage Status

Yoast AI Frontend

The Yoast AI Frontend is a collection of React Components that serve as the building blocks for integrating Yoast AI into any platform. It also contains a reusable API client for interacting with the Yoast AI API.

Note: This package is intended to be used by the Yoast team and its partners only.

Consumption

  1. This package requires partner credentials to interact with the Yoast AI API. Without it, you'll need to provide your own API client implementation.
  2. Run npm install @yoast/ai-frontend, yarn add @yoast/ai-frontend, or use any other package manager of your choice.
  3. Import the components and/or classes you need from the package.

The AI Frontend ships as a single bundle that includes the API client and the React components. Most integrations will use any combination of the Generator components in combination with the API client. For instructions on how to construct and use the Yoast AI API Client, please refer to the AI Client documentation.

Development

Prerequisites

  1. Nvm or Node >= 20
  2. Yarn

Installation

  1. Clone the repository.
  2. cd into it.
  3. If you have nvm installed, run nvm use to switch to the correct node version.
  4. Install the dependencies with yarn install.

Documentation and Testing

The Yoast AI Frontend uses Storybook for documentation and testing (not available when installing through npm). To run the Storybook server, use the following command:

  1. yarn storybook
  2. Open Storybook in your browser at http://localhost:6006.

The generator components are available in the Generators category. They use a mocked API client by default. To switch to the live API client, toggle the useRealAPI switch in the Storybook UI. You'll need to provide your partner credentials in the UI.