tienjs-chartbrew-plugin-strapi 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Chartbrew
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,187 @@
+<p align="center">
+  <a href="https://chartbrew.com">
+    <img src="https://chartbrew-static.b-cdn.net/chartbrew-strapi-plugin-1.png" alt="Chartbrew logo" width="200"/>
+  </a>
+</a>
+
+<p align="center">
+  <a href="https://discord.gg/KwGEbFk" target="_blank"><img src="https://img.shields.io/discord/656557151048957995?label=Chartbrew Discord" alt="" /></a>
+</p>
+
+<p align="center">
+  <h1 align="center">Chartbrew plugin for Strapi</h1>
+</p>
+
+<p align="center">
+  <strong>
+    This is the official <a href="https://chartbrew.com">Chartbrew</a> plugin for <a href="https://strapi.io">Strapi</a>. Chartbrew is an open-source web application that can connect directly to Strapi and other data sources and use the data to create beautiful charts. It features a chart builder, editable dashboards, embedable charts, query & requests editor, and team capabilities.
+  </strong>
+</p>
+
+<br />
+
+![](https://raw.githubusercontent.com/chartbrew/strapi-plugin-chartbrew/master/admin/src/assets/strapi-chartbrew-dashboard.jpg)
+
+<br />
+
+## ✨ Plugin features
+
+* Explore your Chartbrew dashboards directly on Strapi
+* Multi-dashboard support, can switch between them
+* Create dashboards from your collection types from the Strapi interface
+* Add charts to existing dashboards straight from Strapi
+* The charts are kept up-to-date automatically (you can set an update schedule on Chartbrew)
+
+## 📦 Plugin versions
+* If you are using Strapi v5 and Chartbrew v4, use version `3+`
+* If you are using Strapi v5 and Chartbrew v3, use version `2.x.x`
+* If you are using Strapi v4, use version `1.x.x`
+
+## 👋 Get started with Chartbrew
+
+To use this plugin, you will need to have a Chartbrew account, or self-host the platform.
+
+### Chartbrew account
+
+Chartbrew is offered as a managed service in exchange for a monthly subscription. This is the fastest way to get started and create visualizations in Strapi. Follow the instructions below to get started:
+
+1. [Create a new account here](https://app.chartbrew.com/signup)
+2. [Follow this tutorial](https://chartbrew.com/blog/how-to-create-api-keys-in-chartbrew/) to get a Chartbrew API Key to use for Strapi
+
+### Self-hosting
+
+Chartbrew is 100% open-source and can be self-hosted. Check out some links to get you started:
+
+* 😺 [Chartbrew GitHub](https://github.com/chartbrew/chartbrew)
+* 📔 [Chartbrew docs](https://docs.chartbrew.com)
+* 🐳 [Get started with the Chartbrew Docker image](https://docs.chartbrew.com/deployment/#run-the-application-with-docker)
+* 🚀 [Deploy Chartbrew on Heroku & Vercel](https://chartbrew.com/blog/how-to-deploy-chartbrew-on-heroku-and-vercel/)
+
+## 🔧 Plugin Installation
+
+Navigate to the root of your Strapi folder and run the installation commands below.
+
+With `npm`:
+
+```
+npm install --save @chartbrew/plugin-strapi
+```
+
+With `yarn`:
+
+```
+yarn add @chartbrew/plugin-strapi
+```
+
+Add the following attribute in the `config/plugins.js` file:
+
+```
+chartbrew: true
+```
+
+Or if you do not have the `plugins.js` file yet, add the file with the following contents:
+
+```
+module.exports = () => ({
+  chartbrew: true,
+});
+```
+
+And finally, run the build command:
+
+```
+npm run build
+```
+
+Or if you are using `yarn`:
+
+```
+yarn build
+```
+
+## ⚙️ Plugin settings
+
+In order for the plugin to work properly, it needs the right credentials to authenticate with Chartbrew.
+
+The plugin can also create charts straight from Strapi, but this needs access to Strapi through an API token.
+
+Follow the instructions below to learn how to configure the plugin.
+
+### Chartbrew connection
+
+If you self-host Chartbrew, you will have to enter the frontend and backend addresses. The default values are:
+
+* Frontend: `http://localhost:4018`
+* Backend: `http://localhost:4019`
+
+If you want to use the plugin with a managed service account at [chartbrew.com](https://chartbrew.com), click on the **Use managed Chartbrew address** button as shown below:
+
+![](https://raw.githubusercontent.com/chartbrew/strapi-plugin-chartbrew/master/admin/src/assets/chartbrew-connection.jpg)
+
+### Cannot load the dashboards
+
+If you cannot load the dashboard, you may have to tweak the Strapi security settings. To do this, open the `config/middlewares.js` file and add the following attribute:
+
+```
+{
+  name: "strapi::security",
+  config: {
+    contentSecurityPolicy: {
+      useDefaults: true,
+      directives: {
+        "default-src": ["'self'"],
+        "frame-src": ["'self'", "https://app.chartbrew.com"], // allow Chartbrew iframe
+        // If your Strapi admin runs on localhost and does websockets, keep these sane too:
+        "connect-src": ["'self'", "ws://localhost:1337", "https://app.chartbrew.com"],
+      },
+    },
+  },
+}
+```
+
+If you are self-hosting Chartbrew, you will need to replace `https://app.chartbrew.com` with your own Chartbrew client URL.
+
+### Cannot authenticate with Chartbrew
+
+[**Read more here**](https://github.com/chartbrew/strapi-plugin-chartbrew/issues/13)
+
+If you run both Strapi and Chartbrew on `localhost` or on a non-secure connection (http), you will need to tweak the Strapi security settings. To do this, open the `config/middlewares.js` file and add the following attribute:
+
+```
+module.exports = [
+...
+  {
+    name: 'strapi::security',
+    config: {
+      contentSecurityPolicy: {
+        useDefaults: true,
+        directives: {
+          'connect-src': ["'self'", 'http:', 'https:'],
+          upgradeInsecureRequests: null,
+        },
+      },
+    },
+  },
+...
+];
+```
+
+And don't forget to build the Strapi project again:
+
+```
+# npm
+npm run build
+
+# yarn
+yarn build
+```
+
+### Create charts from Strapi
+
+You can create charts directly from your Strapi dashboards. To do this, you will need to create a Strapi API Token and add it in the Chartbrew settings page.
+
+![](https://raw.githubusercontent.com/chartbrew/strapi-plugin-chartbrew/master/admin/src/assets/strapi-auth.jpg)
+
+## ⚠️ Dependencies
+
+* Strapi v5+