https://github.com/codemancers/strapi-plugin-stellate

Strapi Plugin Stellate is a plugin for the Strapi headless CMS that provides a convenient way to purge the cache.
https://github.com/codemancers/strapi-plugin-stellate

strapi strapi-cms strapi-plugin

Last synced: 22 days ago
JSON representation

Strapi Plugin Stellate is a plugin for the Strapi headless CMS that provides a convenient way to purge the cache.

• Host: GitHub
• URL: https://github.com/codemancers/strapi-plugin-stellate
• Owner: codemancers
• License: mit
• Created: 2023-04-03T07:50:54.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-12T07:10:41.000Z (over 1 year ago)
• Last Synced: 2024-11-16T06:25:45.243Z (about 2 months ago)
• Topics: strapi, strapi-cms, strapi-plugin
• Language: JavaScript
• Homepage:
• Size: 3.07 MB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# strapi-plugin-stellate

Strapi Plugin Stellate is a plugin for the Strapi headless CMS that provides a convenient way to purge the cache.

## Instalation

To install this plugin, you can run the following command in your Strapi project:

```

npm install @code-mancers/strapi-plugin-stellate

```

OR

```

yarn add @code-mancers/strapi-plugin-stellate

```

## Configuration

Configure the plugin by adding the necessary lines to the `config/plugins.js` file in your Strapi application, including the Stellate API endpoint URL and authentication token.

```

module.exports = ({ env }) => ({

"stellate": {

    enabled: true,

    config: {

      stellateToken: ,

      stellateUrl: ,

    },

  },

})

```

`STELLATE_URL :` URL endpoint of the Stellate API service used to clear the cache.

`STELLATE_TOKEN :` An authentication token used to access the stellate API.

Note: This information should be provided in the plugin configuration. You would need to enter the correct URL endpoint and necessary authentication or authorization tokens to successfully clear the cache.

## Usage

To clear the cache after running `npm run develop` or `yarn develop` in the Strapi application, go to the dropdown and select the collection type for which you want to clear the cache, then click Purge Cache, which will make an HTTP request to the designated URL endpoint with the required authentication token and clear the Strapi CMS cache.

![DashBoard](./docs/Dashboard.png)

![Selection UI](./docs/Selection.png)

![Success](./docs/Success.png)

## Contribution

If you would like to contribute to the development of Strapi Plugin Stellate, you can do so by following these steps:

Fork the repository on GitHub.

Make your changes and commit them to a new branch on your fork.

Submit a pull request to the main repository with a description of your changes.

Your contributions are appreciated!