Initial commit

Author: paulpopus

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+end_of_line = lf
+max_line_length = null

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+dist

README.md

@@ -0,0 +1,39 @@
+# Payload Dashboard Analytics Plugin (ALPHA)
+
+**Expect breaking changes.**
+
+A plugin for [Payload CMS](https://github.com/payloadcms/payload) to connect analytics data to your Payload dashboard.
+
+Roadmap to stable release:
+
+- Support for GA
+- Support for Plausible
+
+## Installation
+
+```bash
+  yarn add @nouance/payload-dashboard-analytics
+  # OR
+  npm i @nouance/payload-dashboard-analytics
+```
+
+## Basic Usage
+
+In the `plugins` array of your [Payload config](https://payloadcms.com/docs/configuration/overview), call the plugin with [options](#options):
+
+```ts
+// add example
+```
+
+## Development
+
+For development purposes, there is a full working example of how this plugin might be used in the [demo](./demo) of this repo. Then:
+
+```bash
+git clone [email protected]:NouanceLabs/payload-dashboard-analytics.git \
+  cd payload-dashboard-analytics && yarn \
+  cd demo && yarn \
+  cp .env.example .env \
+  vim .env \ # add your API creds to this file
+  yarn dev
+```

demo/.env.example

@@ -0,0 +1,4 @@
+MONGODB_URI=
+PAYLOAD_SECRET=
+
+PLAUSIBLE_API_KEY=

demo/.gitignore

@@ -0,0 +1,4 @@
+node_modules
+media
+
+.env

demo/nodemon.json

@@ -0,0 +1,4 @@
+{
+  "ext": "ts",
+  "exec": "ts-node src/server.ts"
+}

demo/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "payload-dashboard-analytics",
+  "description": "Payload project created from blog template",
+  "version": "1.0.0",
+  "main": "dist/server.js",
+  "license": "MIT",
+  "scripts": {
+    "dev": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts nodemon",
+    "build:payload": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload build",
+    "build:server": "tsc",
+    "build": "yarn copyfiles && yarn build:payload && yarn build:server",
+    "serve": "cross-env PAYLOAD_CONFIG_PATH=dist/payload.config.js NODE_ENV=production node dist/server.js",
+    "copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png}\" dist/",
+    "generate:types": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:types",
+    "generate:graphQLSchema": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:graphQLSchema"
+  },
+  "dependencies": {
+    "dotenv": "^8.2.0",
+    "express": "^4.17.1",
+    "payload": "^1.6.15"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.9",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.3",
+    "nodemon": "^2.0.6",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.8.4"
+  }
+}

demo/src/collections/Categories.ts

@@ -0,0 +1,20 @@
+import { CollectionConfig } from 'payload/types';
+
+const Categories: CollectionConfig = {
+  slug: 'categories',
+  admin: {
+    useAsTitle: 'name',
+  },
+  access: {
+    read: () => true,
+  },
+  fields: [
+    {
+      name: 'name',
+      type: 'text',
+    },
+  ],
+  timestamps: false,
+}
+
+export default Categories;

demo/src/collections/Media.ts

@@ -0,0 +1,28 @@
+import path from 'path';
+import type { CollectionConfig } from 'payload/types';
+
+const Media: CollectionConfig = {
+  slug: 'media',
+  upload: {
+    staticDir: path.resolve(__dirname, '../../media'),
+    // Specify the size name that you'd like to use as admin thumbnail
+    adminThumbnail: 'thumbnail',
+    imageSizes: [
+      {
+        height: 400,
+        width: 400,
+        crop: 'center',
+        name: 'thumbnail',
+      },
+      {
+        width: 900,
+        height: 450,
+        crop: 'center',
+        name: 'sixteenByNineMedium',
+      },
+    ],
+  },
+  fields: [],
+};
+
+export default Media;