From 0e57d93ec821957ca9d0fbec024a08936bed7bd8 Mon Sep 17 00:00:00 2001
From: Donkie <daniel.cf.hultgren@gmail.com>
Date: Mon, 18 Dec 2023 21:25:23 +0100
Subject: [PATCH] Moved help stuff to a new dedicated Help page

Also added some cool stats on home page
---
 client/public/locales/en/common.json |   6 ++
 client/src/App.tsx                   |  11 +-
 client/src/pages/help/index.tsx      |  85 ++++++++++++++++
 client/src/pages/home/index.tsx      | 144 +++++++++++++--------------
 4 files changed, 173 insertions(+), 73 deletions(-)
 create mode 100644 client/src/pages/help/index.tsx

diff --git a/client/public/locales/en/common.json b/client/public/locales/en/common.json
index af924a8..636138f 100644
--- a/client/public/locales/en/common.json
+++ b/client/public/locales/en/common.json
@@ -237,6 +237,9 @@
     "home": {
         "home": "Home"
     },
+    "help": {
+        "help": "Help"
+    },
     "table": {
         "actions": "Actions"
     },
@@ -246,6 +249,9 @@
         "home": {
             "list": "Home | Spoolman"
         },
+        "help": {
+            "list": "Help | Spoolman"
+        },
         "filament": {
             "list": "Filaments | Spoolman",
             "show": "#{{id}} Show Filament | Spoolman",
diff --git a/client/src/App.tsx b/client/src/App.tsx
index 652f254..bc2c03e 100644
--- a/client/src/App.tsx
+++ b/client/src/App.tsx
@@ -10,7 +10,7 @@ import dataProvider from "./components/dataProvider";
 import { useTranslation } from "react-i18next";
 import { BrowserRouter, Outlet, Route, Routes } from "react-router-dom";
 import { ColorModeContextProvider } from "./contexts/color-mode";
-import { FileOutlined, HighlightOutlined, HomeOutlined, UserOutlined } from "@ant-design/icons";
+import { FileOutlined, HighlightOutlined, HomeOutlined, QuestionOutlined, UserOutlined } from "@ant-design/icons";
 import { ConfigProvider } from "antd";
 import React from "react";
 import { Locale } from "antd/es/locale";
@@ -139,6 +139,14 @@ function App() {
                     icon: <UserOutlined />,
                   },
                 },
+                {
+                  name: "help",
+                  list: "/help",
+                  meta: {
+                    canDelete: false,
+                    icon: <QuestionOutlined />,
+                  },
+                },
               ]}
               options={{
                 syncWithLocation: true,
@@ -194,6 +202,7 @@ function App() {
                     <Route path="edit/:id" element={<LoadableResourcePage resource="vendors" page="edit" />} />
                     <Route path="show/:id" element={<LoadableResourcePage resource="vendors" page="show" />} />
                   </Route>
+                  <Route path="/help" element={<LoadablePage name="help" />} />
                   <Route path="*" element={<ErrorComponent />} />
                 </Route>
               </Routes>
diff --git a/client/src/pages/help/index.tsx b/client/src/pages/help/index.tsx
new file mode 100644
index 0000000..7394435
--- /dev/null
+++ b/client/src/pages/help/index.tsx
@@ -0,0 +1,85 @@
+import React from "react";
+import { IResourceComponentsProps } from "@refinedev/core";
+import dayjs from "dayjs";
+import utc from "dayjs/plugin/utc";
+import { Content } from "antd/es/layout/layout";
+import { List, theme } from "antd";
+import Title from "antd/es/typography/Title";
+import { FileOutlined, HighlightOutlined, UserOutlined } from "@ant-design/icons";
+import { Link } from "react-router-dom";
+
+dayjs.extend(utc);
+
+const { useToken } = theme;
+
+export const Help: React.FC<IResourceComponentsProps> = () => {
+  const { token } = useToken();
+  // const t = useTranslate();
+
+  return (
+    <Content
+      style={{
+        padding: 20,
+        minHeight: 280,
+        maxWidth: 1000,
+        margin: "0 auto",
+        backgroundColor: token.colorBgContainer,
+        borderRadius: token.borderRadiusLG,
+        color: token.colorText,
+        fontFamily: token.fontFamily,
+        fontSize: token.fontSizeLG,
+        lineHeight: 1.5,
+      }}
+    >
+      <Title>Help</Title>
+      <p>Here are some tips to get you started.</p>
+      <p>Spoolman holds 3 different types of data:</p>
+      <List
+        itemLayout="horizontal"
+        size="large"
+        dataSource={[
+          {
+            title: "Filaments",
+            description: "Brands of filament. They have properties such as name, material, color, diameter, and more.",
+            icon: <HighlightOutlined />,
+          },
+          {
+            title: "Spools",
+            description: "Individual physical spools of a specific filament.",
+            icon: <FileOutlined />,
+          },
+          {
+            title: "Vendors",
+            description: "The companies that make the filament.",
+            icon: <UserOutlined />,
+          },
+        ]}
+        renderItem={(item) => (
+          <List.Item>
+            <List.Item.Meta avatar={item.icon} title={item.title} description={item.description} />
+          </List.Item>
+        )}
+      />
+      <p>
+        To enter a new spool into the database, you first need to create a <Link to="/filament/create">Filament</Link>{" "}
+        object for it. Once that is done, you can then create a <Link to="/spool/create">Spool</Link> object for that
+        individual spool. If you then purchase additional spools of the same filament, you can just create additional
+        Spool objects, and re-use the same Filament object.
+      </p>
+      <p>
+        You can optionally also create a <Link to="/vendor/create">Vendor</Link> object for the company that makes the
+        filament, if you want to track that information.
+      </p>
+      <p>
+        You can connect other 3D printer services to Spoolman, such as Moonraker, which can then automatically track
+        filament usage and update the Spool objects for you. See the{" "}
+        <a href="https://github.com/Donkie/Spoolman#integration-status" target="_blank">
+          Spoolman README
+        </a>{" "}
+        for how to do that.
+      </p>
+    </Content>
+  );
+};
+
+export default Help;
diff --git a/client/src/pages/home/index.tsx b/client/src/pages/home/index.tsx
index b4c7e37..03de5e1 100644
--- a/client/src/pages/home/index.tsx
+++ b/client/src/pages/home/index.tsx
@@ -1,12 +1,14 @@
-import React from "react";
-import { IResourceComponentsProps } from "@refinedev/core";
+import React, { ReactNode } from "react";
+import { IResourceComponentsProps, useList, useTranslate } from "@refinedev/core";
 import dayjs from "dayjs";
 import utc from "dayjs/plugin/utc";
 import { Content } from "antd/es/layout/layout";
-import { Collapse, List, theme } from "antd";
+import { Card, Col, Row, Statistic, theme } from "antd";
 import Title from "antd/es/typography/Title";
 import Logo from "../../icon.svg?react";
-import { FileOutlined, HighlightOutlined, UserOutlined } from "@ant-design/icons";
+import { FileOutlined, HighlightOutlined, PlusOutlined, UnorderedListOutlined, UserOutlined } from "@ant-design/icons";
+import { ISpool } from "../spools/model";
+import { Link } from "react-router-dom";
 
 dayjs.extend(utc);
 
@@ -14,14 +16,47 @@ const { useToken } = theme;
 
 export const Home: React.FC<IResourceComponentsProps> = () => {
   const { token } = useToken();
-  // const t = useTranslate();
+  const t = useTranslate();
+
+  const spools = useList<ISpool>({
+    resource: "spool",
+    pagination: { pageSize: 1 },
+  });
+  const filaments = useList<ISpool>({
+    resource: "filament",
+    pagination: { pageSize: 1 },
+  });
+  const vendors = useList<ISpool>({
+    resource: "vendor",
+    pagination: { pageSize: 1 },
+  });
+
+  const hasSpools = !spools.data || spools.data.data.length > 0;
+
+  const ResourceStatsCard = (props: { loading: boolean; value: number; resource: string; icon: ReactNode }) => (
+    <Col xs={12} md={6}>
+      <Card
+        loading={props.loading}
+        actions={[
+          <Link to={`/${props.resource}`}>
+            <UnorderedListOutlined />
+          </Link>,
+          <Link to={`/${props.resource}/create`}>
+            <PlusOutlined />
+          </Link>,
+        ]}
+      >
+        <Statistic title={t(`${props.resource}.${props.resource}`)} value={props.value} prefix={props.icon} />
+      </Card>
+    </Col>
+  );
 
   return (
     <Content
       style={{
-        padding: 8,
+        padding: "2em 20px",
         minHeight: 280,
-        maxWidth: 1000,
+        maxWidth: 800,
         margin: "0 auto",
         backgroundColor: token.colorBgContainer,
         borderRadius: token.borderRadiusLG,
@@ -36,15 +71,13 @@ export const Home: React.FC<IResourceComponentsProps> = () => {
           display: "flex",
           alignItems: "center",
           justifyContent: "center",
-          margin: "1em 0",
-          fontSize: token.fontSizeHeading1 + 8,
+          fontSize: token.fontSizeHeading1,
         }}
       >
         <div
           style={{
             display: "inline-block",
             height: "1.5em",
-            float: "left",
             marginRight: "0.5em",
           }}
         >
@@ -52,68 +85,35 @@ export const Home: React.FC<IResourceComponentsProps> = () => {
         </div>
         Spoolman
       </Title>
-      <Collapse
-        className="site-collapse-custom-collapse"
-        items={[
-          {
-            key: "1",
-            label: <span style={{ fontSize: "200%" }}>Getting Started</span>,
-            children: (
-              <>
-                <p>Here are some tips to get you started.</p>
-                <p>Spoolman holds 3 different types of data:</p>
-                <List
-                  itemLayout="horizontal"
-                  size="large"
-                  dataSource={[
-                    {
-                      title: "Filaments",
-                      description:
-                        "Brands of filament. They have properties such as name, material, color, diameter, and more.",
-                      icon: <HighlightOutlined />,
-                    },
-                    {
-                      title: "Spools",
-                      description: "Individual physical spools of a specific filament.",
-                      icon: <FileOutlined />,
-                    },
-                    {
-                      title: "Vendors",
-                      description: "The companies that make the filament.",
-                      icon: <UserOutlined />,
-                    },
-                  ]}
-                  renderItem={(item) => (
-                    <List.Item>
-                      <List.Item.Meta avatar={item.icon} title={item.title} description={item.description} />
-                    </List.Item>
-                  )}
-                />
-                <p>
-                  To enter a new spool into the database, you first need to create a <strong>Filament</strong> object
-                  for it. Once that is done, you can then create a <strong>Spool</strong> object for that individual
-                  spool. If you then purchase additional spools of the same filament, you can just create additional
-                  Spool objects, and re-use the same Filament object.
-                </p>
-                <p>
-                  You can optionally also create a <strong>Vendor</strong> object for the company that makes the
-                  filament, if you want to track that information.
-                </p>
-                <p>
-                  You can connect other 3D printer services to Spoolman, such as Moonraker, which can then automatically
-                  track filament usage and update the Spool objects for you. See the{" "}
-                  <a href="https://github.com/Donkie/Spoolman#integration-status" target="_blank">
-                    Spoolman README
-                  </a>{" "}
-                  for how to do that.
-                </p>
-              </>
-            ),
-          },
-        ]}
-        bordered={false}
-        ghost
-      />
+      <Row justify="center" gutter={[16, 16]} style={{ marginTop: "3em" }}>
+        <ResourceStatsCard
+          resource="spool"
+          value={spools.data?.total || 0}
+          loading={spools.isLoading}
+          icon={<FileOutlined />}
+        />
+        <ResourceStatsCard
+          resource="filament"
+          value={filaments.data?.total || 0}
+          loading={filaments.isLoading}
+          icon={<HighlightOutlined />}
+        />
+        <ResourceStatsCard
+          resource="vendor"
+          value={vendors.data?.total || 0}
+          loading={vendors.isLoading}
+          icon={<UserOutlined />}
+        />
+      </Row>
+      {!hasSpools && (
+        <>
+          <p style={{ marginTop: 32 }}>Welcome to your Spoolman instance!</p>
+          <p>
+            It looks like you haven't added any spools yet. See the <Link to="/help">Help page</Link> for help getting
+            started.
+          </p>
+        </>
+      )}
     </Content>
   );
 };