Merge pull request #6 from acaptutorials/dev

v1.0.1
acaptutorials · Jul 8, 2023 · 7c2d351 · 7c2d351
2 parents 5443d59 + e24cace
commit 7c2d351
Show file tree

Hide file tree

Showing 5 changed files with 106 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -1,24 +1,73 @@
 ## assets-cms
 
-Dynamic widgets/apps for external website embedding on Google Sites.<br>
-This project will also serve as a Content Management System (CMS) for tracking and hosting common ACAP assets.
+This project creates rich CSS-styled blog-like **Posts** or **Card-like** thumbnail web pages for embedding in Google Sites as external websites.
+
+It also features a lightweight Content Management System (CMS) for creating and managing Google Site embeddable blog-like **Posts** and **Card** content.
+
+### Online App
+
+https://acaptutorials.github.io/assets-cms/
+
+### Using with Google Sites
+
+### A. Embed a File Card
+
+1. Copy a File Card's `IFrame Embed URL`.
+2. Paste the `IFrame Embed URL` in Google Site's **Embed from the web** - By URL input prompt.
+3. Preview or Publish the Google Site draft page.
+
+Google Sites Sample Web page:<br>
+https://sites.google.com/view/gsites-embed-app/home
+
+![gsites-embed-03-ez-optimized](https://github.com/weaponsforge/climate-profile-full/assets/56998001/21c07402-904d-4e41-9988-9108c8c683cc)
+
+### B. Embed a Full Page Containing a Group of File Cards
+
+1. Copy a File Card's `Cards Gallery URL`.
+2. Create a **Full page embed** Google Site draft page.
+3. Press the **Add embed** button in the resulting blank page and paste the `Cards Gallery URL` in the **Embed from the web** - By URL input prompt.
+   - This page will display all File Cards with similar `"category"` field value like the current Card.
+4. Preview or Publish the Google Site draft page.
+
+Google Sites Sample Web page:<br>
+https://sites.google.com/view/gsites-embed-app/full-page
+
+![gsites-full-embed-ez](https://github.com/weaponsforge/climate-profile-full/assets/56998001/dce2c297-3e3d-4073-a9f2-5f51a2590a91)
 
 ## Requirements
 
 1. Windows, Linux or Mac OS
 2. NodeJS LTS v16.14.2
+3. Firebase Project
 
 ### Core Libraries/Frameworks
 
-1. NextJS v13.0.4
-2. React 18.2.0
-3. @reduxjs/toolkit v1.9.3
-4. firebase v9.18.0
-5. firebase-admin v11.5.0
-
-### Online App
-
-https://acaptutorials.github.io/assets-cms/
+1. **NextJS v13.0.4** (client-side SSG)
+   - NextJS is one of the @latest React frameworks officially endorsed on the react.dev website
+   - NextJS's Static Side Generation (SSG) feature, combined with Incremental Static Generation (ISG) creates SEO-optimized websites fit for uploading on static hosting services such as GitHub Pages.
+   - NextJS offers code automatic code-splitting, enabling a smaller download footprint per page route
+2. **React 18.2.0**
+   - React version 18's is the latest react version as of this writing
+3. **@reduxjs/toolkit v1.9.3**
+   - Redux offers a structured, organized, and centralized global "state management" system as a single source of truth that occasionally syncs with the database.
+   - Redux states are available across all components using intuitively-named hooks.
+   - Redux states are more predictable, consistent and less prone to errors by
+     - promoting data normalization (which is optional), and
+     - use of reducers which ensures data immutability
+   - Its async data fetching mechanisms and middleware sync well with complex store states and of informing the client app of the loading state.
+   - Redux states are easy to debug using the Redux Dev tools.
+   - People can easily follow where the centralized data stores and async data fetching methods are located in the code base when working in teams, especially for large, complex enterprise apps.
+   - Redux state management will scale well with this app's incoming feature updates containing more complex data models and states.
+   - Redux has excellent documentation and a thriving community, and it has proven to be one of the most mature, albeit boilerplates and complex react state management libraries of all time.
+4. **firebase v9.18.0**
+   - Firebase, being a Backend-as-a-Service (Baas), makes it possible to create apps without creating a separate backend server app.
+     - Firebase offers a Web (JavaScript) SDK for working on the frontend (websites) and the Firebase Admin SDK for client-side scripting.
+   - Firebase offers ready to use Authentication systems
+   - Firestore database provides a lightweight document database for storing and querying simple data. Security is enforced using the Firebase Security Rules.
+   - Firebase Storage provides an easy-to-use and access container for rich-data content. Security is enforced using the Firebase Storage Security Rules.
+   - Firebase offers generous limits for testing and playing around with its Spark (standard) plan, after which users can upgrade to the Blaze (paid) Plan as needed.
+5. **firebase-admin v11.5.0**
+   - The Firebase Admin SDK allows elevated scripting access to various Firebase services, that are not available when using the Firebase (JavaScript) SDK.
 
 ## Installation
 
@@ -38,5 +87,9 @@ https://acaptutorials.github.io/assets-cms/
 
 2. Follow the instructions in the README files inside the **/client** and **/server** directories for more information on configuring and using the client and server apps.
 
+3. Create an account after setting up the **/server** `.env` using the instructions in it's README file.<br>
+   - Navigate to the /server directory from the commandline and run:<br>
+`npm run user:create [email protected] --password=anypasasword --displayname="Game Tester" --emailverified=true`
+
 @acaptutorials<br>
 20230326
diff --git a/client/components/common/ui/smartnotification/index.js b/client/components/common/ui/smartnotification/index.js
@@ -27,7 +27,7 @@ function SmartNotification () {
       {(open && notification !== '') &&
       <Snackbar
         open={open}
-        autoHideDuration={4000}
+        autoHideDuration={2000}
         onClose={() => dispatch(resetMessage())}
         sx={{
           maxWidth: '600px',

diff --git a/client/features/filecards/components/formitemsview/index.js b/client/features/filecards/components/formitemsview/index.js
@@ -1,5 +1,5 @@
 import { useState, useCallback, useEffect, useMemo } from 'react'
-import { useDispatch } from 'react-redux'
+import { useDispatch, useSelector } from 'react-redux'
 import Link from 'next/link'
 import PropTypes from 'prop-types'
 
@@ -20,17 +20,20 @@ import { MESSAGE_SEVERITY } from '@/store/app/appSlice'
 function FormItemsView ({ card }) {
   const [embedUrl, setEmbedUrl] = useState('')
   const dispatch = useDispatch()
+  const notification = useSelector(state => state.app.notification)
   const collapse = useMediaQuery('(max-width:1100px)')
 
   const subDirectory = (process.env.NEXT_PUBLIC_BASE_PATH !== '')
     ? process.env.NEXT_PUBLIC_BASE_PATH
     : ''
 
-  const incrementTimestamp = useCallback(() => {
+  const incrementTimestamp = useCallback((isCard = true) => {
     const timestamp = Math.floor((new Date()).getTime() / 1000)
 
     return (card !== null)
-      ? `${window.location.origin}${subDirectory}/cards/embed?id=${card.id}&ts=${timestamp}`
+      ? (isCard)
+        ? `${window.location.origin}${subDirectory}/cards/embed?id=${card.id}&ts=${timestamp}`
+        : `${window.location.origin}${subDirectory}/cards/gallery?category=${card.category}&ts=${timestamp}`
       : window.location.origin
   }, [card, subDirectory])
 
@@ -41,12 +44,12 @@ function FormItemsView ({ card }) {
   }, [card, subDirectory])
 
   useEffect(() => {
-    const embed = incrementTimestamp()
+    const embed = incrementTimestamp(true)
     setEmbedUrl(embed)
   }, [incrementTimestamp])
 
-  const copyToClipboard = () => {
-    const embed = incrementTimestamp()
+  const copyToClipboard = (isCard = true) => {
+    const embed = incrementTimestamp(isCard)
     setEmbedUrl(embed)
     navigator.clipboard.writeText(embed)
 
@@ -122,13 +125,19 @@ function FormItemsView ({ card }) {
                 </Link>
               </Typography>
 
-              <Button size="small" disableElevation variant="contained" color="secondary" onClick={copyToClipboard}>
+              <Button
+                size="small"
+                disableElevation variant="contained"
+                color="secondary"
+                disabled={notification !== ''}
+                onClick={() => copyToClipboard(true)}
+              >
                 <ContentPasteIcon sx={{ fontSize: '20px' }} />
               </Button>
             </Box>
 
             <Typography variant="caption">
-              Press the Copy Button to copy the IFrame embed URL to clipboard
+              Press the Copy Button to copy this card&apos;s IFrame embed URL to clipboard
             </Typography>
 
             {/** Cards Gallery URL */}
@@ -143,7 +152,21 @@ function FormItemsView ({ card }) {
                     {cardGalleryURL}
                   </Link>
                 </Typography>
+
+                <Button
+                  size="small"
+                  disableElevation variant="contained"
+                  color="secondary"
+                  disabled={notification !== ''}
+                  onClick={() => copyToClipboard(false)}
+                >
+                  <ContentPasteIcon sx={{ fontSize: '20px' }} />
+                </Button>
               </Box>
+
+              <Typography variant="caption">
+                Press the Copy Button to copy the <b>{card.category}</b> cards gallery embed URL to clipboard
+              </Typography>
             </div>
           </Box>
         </Box>

diff --git a/client/features/filecards/constants/mimetypes.json b/client/features/filecards/constants/mimetypes.json
@@ -152,5 +152,12 @@
     "EXT": ".zip",
     "LABEL": "ZIP archive (.zip)",
     "CODE": "ARCHIVE_ZIP"
+  },
+  {
+    "id": 22,
+    "MIME_TYPE": "application/x-zip-compressed",
+    "EXT": ".zip",
+    "LABEL": "ZIP archive compressed (.zip)",
+    "CODE": "ARCHIVE_ZIP_COMPRESSED"
   }
 ]
diff --git a/server/src/scripts/user/delete.js b/server/src/scripts/user/delete.js
@@ -4,7 +4,9 @@ const getargs = require('../../utils/getargs')
 const deleteExistingUser = async () => {
   try {
     // Get the nodejs args
-    const args = getargs(['email'])
+    const args = getargs({
+      params: ['email']
+    })
 
     // Get the user data
     const user = await getuser({