Documentation enhancement

.env-cmdrc.js

@@ -0,0 +1,46 @@
+// Run a pre-flight check that developer environment setup in compatible way
+import { envCheck } from './scripts/envCheck'
+if (!process.env.CI) {
+  envCheck()
+}
+
+// Specific settings to use when running anything that requires a webpack compiler
+// Enabled when npm command specifies `env-cmd -e webpack`
+let webpack = {
+  NODE_OPTIONS: getNodeOptions(),
+}
+
+// Specific env to use with react-scripts / create-react-app
+// Enabled when npm command specifies `env-cmd -e cra`
+let cra = {
+  ...webpack,
+  FAST_REFRESH: false,
+}
+
+exports.cra = cra
+exports.webpack = webpack
+
+/** Determine what node_options to provide depending on context */
+function getNodeOptions() {
+  // Depending on node version use different environment variables to fix
+  // specific build or run issues
+  const NODE_VERSION = process.versions.node.split('.')[0]
+
+  let NODE_OPTIONS = process.env.NODE_OPTIONS || ''
+
+  // fix out-of-memory issues - default to 4GB but allow override from CI
+  // NOTE - would like to auto-calculate but does not support CI (https://github.com/nodejs/node/issues/27170)
+  if (!NODE_OPTIONS.includes('--max-old-space-size')) {
+    NODE_OPTIONS += ` --max-old-space-size=4096`
+  }
+  if (NODE_VERSION > '17') {
+    // fix https://github.com/facebook/create-react-app/issues/11708
+    // https://github.com/facebook/create-react-app/issues/12431
+    NODE_OPTIONS += ' --openssl-legacy-provider --no-experimental-fetch'
+  }
+
+  if (process.env.CI) {
+    console.log('NODE_OPTIONS', NODE_OPTIONS, '\n')
+  }
+  return NODE_OPTIONS.trim()
+}

CONTRIBUTING.md

@@ -1,3 +1,6 @@
+Hey there, Future Contributor! Welcome to our project playground! Before you dive in and start contributing your awesome ideas, please take a moment to check out our [Official Documentation](https://onearmy.github.io/community-platform/).
+
+
 # Contribution Guidelines
 
 Thanks for being here already! You'll find all the information you need to start contributing to the project. Make sure to read them before submitting your contribution.

README.md

@@ -8,9 +8,10 @@
 # 🔗   tl;dr Quick Links
 
 - [Project Website](https://platform.onearmy.earth)
+- [Project Kamp Community Platform (live site)](https://community.projectkamp.com/)
 - [Precious Plastic Community Platform (live site)](http://community.preciousplastic.com/)
+- [Fixing Fashion Community Platform (live site)](https://community.fixing.fashion/)
 - [Developer documentation](https://onearmy.github.io/community-platform/)
-- [Contributing Guide](/CONTRIBUTING.md)
 
 # 🌍   Community Platform
 

functions/src/Utils/db.utils.test.ts

@@ -0,0 +1,37 @@
+import { getDiscussionCollectionName, randomID } from './db.utils'
+
+describe('getDiscussionCollectionName', () => {
+  it('should return "questions" when sourceType is "question"', () => {
+    const result = getDiscussionCollectionName('question')
+    expect(result).toBe('questions')
+  })
+
+  it('should return "howtos" when sourceType is "howto"', () => {
+    const result = getDiscussionCollectionName('howto')
+    expect(result).toBe('howtos')
+  })
+
+  it('should return null when sourceType is unrecognized', () => {
+    const result = getDiscussionCollectionName('unknown')
+    expect(result).toBe(null)
+  })
+  it('should return null when sourceType is an empty string', () => {
+    const result = getDiscussionCollectionName('')
+    expect(result).toBeNull()
+  })
+
+  it('should return "research" when sourceType is "researchUpdate"', () => {
+    const result = getDiscussionCollectionName('researchUpdate')
+    expect(result).toBe('research')
+  })
+})
+
+describe('randomID', () => {
+  // generates a string of length 20
+  it('should generate a string of length 20 and include only alphanumeric characters', () => {
+    const id = randomID()
+    const alphanumericRegex = /^[a-zA-Z0-9]+$/
+    expect(id).toHaveLength(20)
+    expect(alphanumericRegex.test(id)).toBe(true)
+  })
+})

functions/src/Utils/db.utils.ts

@@ -0,0 +1,31 @@
+export type DiscussionEndpoints = 'howtos' | 'research' | 'questions'
+
+/**
+ *  Function used to determine the discussion collection name based on the source type.
+ */
+export const getDiscussionCollectionName = (
+  sourceType: string,
+): DiscussionEndpoints | null => {
+  switch (sourceType) {
+    case 'question':
+      return 'questions'
+    case 'howto':
+      return 'howtos'
+    case 'researchUpdate':
+      return 'research'
+    default:
+      return null
+  }
+}
+
+/**
+ *  Function used to generate random ID in same manner as firestore
+ */
+export const randomID = () => {
+  const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
+  let autoId = ''
+  for (let i = 0; i < 20; i++) {
+    autoId += chars.charAt(Math.floor(Math.random() * chars.length))
+  }
+  return autoId
+}

functions/src/Utils/index.ts

@@ -1,3 +1,4 @@
 export * from './auth.utils'
 export * from './data.utils'
 export * from './file.utils'
+export * from './db.utils'