strapi-plugin-sdk-bridge v1.0.1

Strapi - SDK Bridge plugin

Bridge for the Strapi SDK JS package CLI to generate types based on your API content types.

• ✨  Release Notes

How it works?

1. Generate JSON schema based on your Strapi content types
2. Aggregate the list of content type with they kind (collection | single) in an array
3. The Strapi SDK will trigger this plugin in order to generate lot of usefull things (Typescript Types, shortcuts methods)

Getting started

⏳ Installation

You have to install this plugin within your Strapi project thanks yarn:

yarn add strapi-generate-types

After successful installation you've to build a fresh package that includes plugin UI. To archive that simply use:

yarn build
yarn develop

or just run Strapi in the development mode with --watch-admin option:

yarn develop --watch-admin

The SDK Bridge plugin should appear in the Plugins section of Strapi sidebar after you run app again.

Enjoy 🎉

🖐 Requirements

Complete installation requirements are exact same as for Strapi itself and can be found in the documentation under Installation Requirements.

Supported Strapi versions:

• Strapi v3.6.0 (recently tested)
• Strapi v3.x

(This plugin may work with the older Strapi versions, but these are not tested nor officially supported at this time.)

We recommend always using the latest version of Strapi to start your new projects.

🕹 Usage

In order to use it, you have to install Strapi SDK JS on your frontend application:

yarn add strapi-sdk-js

or

npm install --save strapi-sdk-js

Then you'll have to go to your admin panel in order to copy your JWT token & paste in a .env file inside your frontend application.

After this step, you'll have to go inside your frontend application and use the CLI, as bellow:

yarn strapi-sdk-js generate

or

npx strapi-sdk-js generate

The prompt will ask your strapi host (default: http://localhost:1337) and generate the Typescript's types & content Type JSON in a models folder

License

MIT License