✨ [Issue-6] Build Data model for Home Page (#8)

* 🔧 small update to data generation: keep logical link between name and username

* 📝 add note regarding user during seed creation

* 🎉 [Issue-6] Build Home Page data
- add Open Graph component
- add Statement component
- add Link component
- add Current Status component
- add news_ticker to Home Page
- add missions to Home Page
- add values to Home Page
- add goals to Home Page
- add heading to Home Page
- add sub_heading to Home Page
- add current_status to Home Page

* 🔨 👽 Seeding Home Page
- fill Home Page
- add uploadFile util

* [issue-6] Remove `home-page: true` indicator such as Single Collection always has only 1 object

Author: andriishupta

cms/src/_seed/helpers.js

@@ -1,4 +1,5 @@
 const { APPLICATION_COLLECTION_TYPE_UIDS } = require('./constants');
+const { statSync } = require('fs');
 
 /**
  * @param {Strapi} strapi
@@ -47,9 +48,42 @@ const sampleSize = (arr, num = Math.floor(Math.random() * arr.length)) => {
   return shuffled.slice(0, num);
 }
 
+/**
+ * @param {Strapi} strapi
+ * @param {Object} data
+ * @param {Object} file
+ * @returns {Promise<{ id }>}
+ */
+const uploadFile = async (strapi, {
+  data,
+  file,
+}) => {
+  const { refId, ref, field } = data
+  const { name, path, type } = file
+
+  const fileStat = statSync(path);
+
+  const [uploadedFile] = await strapi.plugins.upload.services.upload.upload({
+    data: {
+      refId,
+      ref,
+      field
+    },
+    files: {
+      path,
+      name,
+      type,
+      size: fileStat.size,
+    },
+  });
+
+  return uploadedFile
+}
+
 module.exports = {
   ensureSQLite,
   randomBoolean,
   clearData,
-  sampleSize
+  sampleSize,
+  uploadFile,
 }

cms/src/_seed/index.js

@@ -2,6 +2,7 @@ const { seedUserExists, generateUserData } = require('./user');
 const { clearData } = require('./helpers');
 const { generatePartnerData } = require('./partner');
 const { generateProjectAndContributorData } = require('./project-and-contributor');
+const { fillHomePage } = require('./pages');
 
 /**
  * @param {Strapi} strapi
@@ -35,6 +36,14 @@ const generateSeedData = async (strapi) => {
     throw new Error(e)
   })
 
+  // Pages
+  await Promise.all([
+    fillHomePage(strapi),
+  ]).catch(e => {
+    console.error('error during generating page data! Stopping the application...')
+    throw new Error(e)
+  })
+
   console.log('generating seed data has been finished successfully!')
 }
 

cms/src/_seed/media/d_d-dark.jpeg

@@ -0,0 +1,132 @@
+const { join } = require('path')
+const { uploadFile } = require('../helpers');
+
+/**
+ * @param {Strapi} strapi
+ * @returns {Promise<void>}
+ */
+const fillHomePage = async (strapi) => {
+  console.log('filling home page...')
+
+  let homePageObject = await strapi.entityService.findMany('api::home-page.home-page', {})
+
+  if (!homePageObject) {
+    homePageObject = await strapi.entityService.create('api::home-page.home-page', {
+      data: {
+        heading: 'tmp_required_value',
+        publishedAt: new Date().toISOString()
+      }
+    })
+  }
+
+  const logoPath = join(__dirname, '../media/d_d-dark.jpeg')
+  const logo = await uploadFile(strapi, {
+    data: {
+      refId: homePageObject.id,
+      ref: 'api::home-page.home-page',
+      field: 'logo',
+    },
+    file: {
+      path: logoPath,
+      name: 'd_d-dark.jpeg',
+      type: 'image/jpeg'
+    },
+  })
+
+  console.log('logo for Footer has been created!')
+
+  const partners = (await strapi.entityService.findMany('api::partner.partner', {
+    limit: 5
+  })).map(partner => partner.id)
+
+  await strapi.entityService.update('api::home-page.home-page', homePageObject.id, {
+    data: {
+      heading: 'Build web3 with friends.',
+      sub_heading: 'Developer DAO is a community of thousand of web3 builders creating a better internet. Join us and create the future.',
+      news_ticker: [{
+        name: 'membership',
+        title: 'MEMBERSHIP_OPEN!',
+        description: 'Good luck getting the DAO NFT!'
+      }, {
+        name: 'status',
+        title: 'Current Status: Season 0',
+        description: 'GM frens!'
+      }],
+      values: [{
+        name: 'transparency',
+        title: 'Transparency',
+        description: 'Open Source Everything, Conversations In Public, Document And Share Journey',
+      }, {
+        name: 'diversity_inclusion',
+        title: 'Diversity and Inclusion',
+        description: 'Seek To Foster As Diverse A Membership As Possible And Support Everyone To Contribute',
+      }, {
+        name: 'responsibility',
+        title: 'Responsibility',
+        description: 'As A Self-governed Community We Rely On Members To Be Personally Responsible For Their Actions And Commitments To The Community',
+      }, {
+        name: 'kindness_empathy',
+        title: 'Kindness and Empathy',
+        description: 'We Know That We Are Living In A Complex, Stressful, And Diverse World And Go Out Of Our Way To Make People’s Lives And Days Better Through Our Interactions',
+      }],
+      mission: 'Developer DAO exists to accelerate the education and impact of a new wave of web3 builders.',
+      goals: [{
+        name: 'goal_1',
+        title: 'goal_1',
+        description: 'Onboard, Educate & Support Web3 Developers'
+      }, {
+        name: 'goal_2',
+        title: 'goal_2',
+        description: 'Foster & Build Web3 Tools & Public Goods'
+      }],
+      partners,
+      footer: {
+        logo: logo.id,
+        useful_links: [{
+          name: 'developerdao_wiki',
+          title: 'Wiki',
+          link: 'https://developerdao.notion.site/developerdao/Developer-DAO-Wiki-eff4dcb00bef46fbaa93e9e4cf940e2e',
+        }, {
+          name: 'developerdao_forum',
+          title: 'Forum',
+          link: 'https://forum.developerdao.com/',
+        }],
+        discover: [{
+          name: 'developerdao_blog',
+          title: 'Blog',
+          link: 'https://developerdao.notion.site/Newsletter-d9c971f2bea446338624042ea20547f9'
+        }],
+        social: [{
+          name: 'twitter',
+          title: 'Twitter',
+          link: 'https://twitter.com/developer_dao',
+          type: 'social'
+        }]
+      },
+      meta_og: {
+        title: 'The Developer DAO',
+        description: 'Building web3 with friends',
+        image: 'https://www.developerdao.com/D_D_logo-dark.svg',
+        image_media: logo.id
+      },
+      current_status: {
+        statement: {
+          name: 'season_0',
+          title: 'Current Status: Season 0',
+          description: 'We’re forming guilds, creating culture, strengthening our community, teaching & learning, and building cool things together.'
+        },
+        link: {
+          name: 'snapshot',
+          title: 'Read our snapshot',
+          link: 'https://developerdao.notion.site/How-to-use-Snapshot-32692309faf446ddb2a898f22050fb5f#05f55b4052c044169402a443b36945ff'
+        }
+      }
+    }
+  })
+
+  console.log('home page has been filled successfully!')
+}
+
+module.exports = {
+  fillHomePage,
+}

cms/src/_seed/media/d_d-light.jpeg

@@ -0,0 +1,5 @@
+const { fillHomePage } = require('./home-page')
+
+module.exports = {
+  fillHomePage
+}

cms/src/_seed/pages/home-page.js

@@ -1,5 +1,6 @@
 const { faker } = require('@faker-js/faker');
-const { randomBoolean } = require('./helpers');
+const { randomBoolean, uploadFile } = require('./helpers');
+const { join } = require('path');
 
 /**
  * @param {Strapi} strapi
@@ -11,29 +12,58 @@ const generatePartnerData = async (strapi) => {
   const { DEV_SEED_DATA_PARTNERS } = process.env
   const partnersSize = DEV_SEED_DATA_PARTNERS ? parseInt(DEV_SEED_DATA_PARTNERS) : 5
 
+  const logoLight = await uploadFile(strapi, {
+    data: {
+      refId: Date.now(),
+      ref: 'api::partner.partner',
+      field: 'logo_light',
+    },
+    file: {
+      path: join(__dirname, './media/d_d-light.jpeg'),
+      name: 'd_d-light.jpeg',
+      type: 'image/jpeg'
+    },
+  })
+  const logoDark = await uploadFile(strapi, {
+    data: {
+      refId: Date.now(),
+      ref: 'api::partner.partner',
+      field: 'logo_dark',
+    },
+    file: {
+      path:  join(__dirname, './media/d_d-dark.jpeg'),
+      name: 'd_d-dark.jpeg',
+      type: 'image/jpeg'
+    },
+  })
+
   const bulkPartnerPromises = []
   const randomPartnersData = new Array(partnersSize).fill(null).map(_randomPartner)
 
   for (const randomPartnerData of randomPartnersData) {
-    const randomPartnerPromise = strapi.entityService.create('api::partner.partner', { data: randomPartnerData })
+    const randomPartnerPromise = strapi.entityService.create('api::partner.partner', {
+      data: {
+        ...randomPartnerData,
+        logo_light: logoLight.id,
+        logo_dark: logoDark.id,
+      }
+    })
     bulkPartnerPromises.push(randomPartnerPromise)
   }
 
   await Promise.all(bulkPartnerPromises)
 }
 
-const _randomPartner = () => ({
-  name: faker.company.companyName(),
-  website: faker.internet.url(),
-  twitter_handle: faker.internet.userName().toLowerCase(),
-  publishedAt: randomBoolean() ? new Date().toISOString() : null
-  /**
-   * "Media Library Upload" is only working via RestAPI, but when we generate seed data, no server is running
-   * Skipping logos generation so far
-   */
-  // logo_dark
-  // logo_light
-})
+const _randomPartner = () => {
+  const name = faker.company.companyName()
+
+  return {
+    name,
+    website: faker.internet.url(),
+    twitter_handle: faker.internet.userName(name).toLowerCase(),
+    publishedAt: randomBoolean() ? new Date().toISOString() : null
+  }
+}
 
 module.exports = {
   generatePartnerData

cms/src/_seed/pages/index.js

@@ -40,10 +40,11 @@ const generateProjectAndContributorData = async (strapi) => {
 }
 
 const _randomProject = () => {
-  const username = faker.internet.userName().toLowerCase()
+  const name = faker.company.companyName()
+  const username = faker.internet.userName(name).toLowerCase()
 
   return {
-    name: faker.company.companyName(),
+    name,
     hero_image: faker.image.avatar(),
     description_short: faker.company.bs(),
     description_long: faker.lorem.paragraph(),
@@ -55,10 +56,11 @@ const _randomProject = () => {
 }
 
 const _randomContributor = () => {
-  const username = faker.internet.userName().toLowerCase()
+  const name = faker.name.findName()
+  const username = faker.internet.userName(name).toLowerCase()
 
   return {
-    name: faker.name.findName(),
+    name,
     ens_name: `${ username }.eth`,
     twitter_handle: username,
     discord_handle: `${ username }#${ faker.random.numeric(4) }`,

cms/src/_seed/partner.js

@@ -18,6 +18,10 @@ const seedUserExists = async (strapi) => {
  * @returns {Promise<void>}
  */
 const createSeedUser = async (strapi) => {
+  // TODO: needs update - cannot login with this API-created user
+  // checkout how [user-permissions] plugin registers user via REST - jwt issuing required
+  // https://github.com/strapi/strapi/blob/master/packages/plugins/users-permissions/server/controllers/auth.js#L239
+
   const now = Date.now()
 
   await strapi.entityService.create('plugin::users-permissions.user', {

cms/src/_seed/project-and-contributor.js

@@ -16,6 +16,47 @@
       "type": "relation",
       "relation": "oneToMany",
       "target": "api::partner.partner"
+    },
+    "heading": {
+      "type": "string",
+      "required": true
+    },
+    "sub_heading": {
+      "type": "text"
+    },
+    "footer": {
+      "type": "component",
+      "repeatable": false,
+      "component": "general.footer",
+      "required": false
+    },
+    "mission": {
+      "type": "text"
+    },
+    "values": {
+      "type": "component",
+      "repeatable": true,
+      "component": "general.statement"
+    },
+    "goals": {
+      "type": "component",
+      "repeatable": true,
+      "component": "general.statement"
+    },
+    "news_ticker": {
+      "type": "component",
+      "repeatable": true,
+      "component": "general.statement"
+    },
+    "meta_og": {
+      "type": "component",
+      "repeatable": false,
+      "component": "general.open-graph"
+    },
+    "current_status": {
+      "type": "component",
+      "repeatable": false,
+      "component": "home-page.current-status"
     }
   }
 }