Merge pull request #11 from 0xdevant/feat/enable-scoring-model

feat: enable scoring model on Project by certain data points

components/Project/ProjectHeading.vue

@@ -1,5 +1,5 @@
 <script lang="ts" setup>
-import type { Project } from '~/types'
+import type { Project, ProjectIndexable } from '~/types'
 
 const props = defineProps<{
   project: Project
@@ -13,16 +13,79 @@ const availableSupport = computed(() => {
   return 0
 })
 
+/**
+ * From data points
+  - product readiness
+  - docs (yes/no)
+  - github (yes/no)
+  - team: anon / public
+  - audit: yes / no
+ */
+const calculateScore = computed(() => {
+  const criterias: { value: string; key: string }[] = [
+    { value: 'product_readiness', key: '' },
+    { value: 'github', key: 'links' },
+    { value: 'docs', key: 'links' },
+    { value: 'team', key: '' },
+    { value: 'audits', key: '' },
+  ]
+
+  let matched = 0
+  for (let i = 0; i < criterias.length; i++) {
+    let value
+    // value = ((criterias[i].key ?? props.project[criterias[i].value as keyof typeof props.project]) ?? null === null) ? null : (props.project as ProjectIndexable)[criterias[i].key][criterias[i].value]
+
+    const indexableProject = (props.project as ProjectIndexable)
+    if (criterias[i].key !== '')
+      value = indexableProject?.[criterias[i].key]?.[criterias[i].value]
+    else
+      value = indexableProject?.[criterias[i].value]
+
+    // console.log(props.project?.links?.github);
+    // console.log(Object.keys(props.indexableProject["team"]).length);
+    if (value === null || value === undefined)
+      continue
+
+    if (fulfilled(value))
+      matched++
+  }
+
+  return 100 / criterias.length * matched
+})
+
+function fulfilled(value: any): boolean {
+  const type = typeof value
+  switch (type) {
+    case 'string':
+      if (value !== '')
+        return true
+      break
+    case 'object':
+      if (Object.keys(value).length > 0)
+        return true
+      break
+    default:
+      return false
+  }
+  return false
+}
+
 const logo = props.project?.logos?.at(0)?.url
 </script>
 
 <template>
   <div lg:flex lg:gap-32px>
-    <NuxtImg lg:max-w-320px lg:max-h-320px shrink :src="logo ?? '/no-image-1-1.svg'" class="bg-app-bg-grey object-cover max-w-full h-full vertical-align[middle] block border-0 w-full h-[300px]" />
+    <NuxtImg
+      lg:max-w-320px lg:max-h-320px shrink :src="logo ?? '/no-image-1-1.svg'"
+      class="bg-app-bg-grey object-cover max-w-full h-full vertical-align[middle] block border-0 w-full h-[300px]"
+    />
     <div grow>
       <div flex flex-col justify-between gap-32px lg:flex-row lg:items-center>
         <div mt-24px>
-          <NuxtLink :to="project.links?.web" target="_blank" flex items-center gap-12px hover:underline underline-offset-3>
+          <NuxtLink
+            :to="project.links?.web" target="_blank" flex items-center gap-12px hover:underline
+            underline-offset-3
+          >
             <h1 text="24px sm:32px app-white" leading-32px font-700>
               {{ project.name }}
             </h1>
@@ -33,11 +96,10 @@ const logo = props.project?.logos?.at(0)?.url
           </h2>
         </div>
         <div
-          border-2px
-          class="border-app-black bg-app-white text-app-black"
-          flex items-center justify-center px-32px py-16px text-32px font-700 leading-40px cursor-pointer
+          border-2px class="border-app-black bg-app-white text-app-black" flex items-center justify-center px-32px
+          py-16px text-32px font-700 leading-40px cursor-pointer
         >
-          {{ '63%' }}
+          {{ calculateScore }}
         </div>
       </div>
       <div grid grid-cols-2 gap-16px my-32px lg:grid-cols-4>
@@ -47,7 +109,10 @@ const logo = props.project?.logos?.at(0)?.url
           </template>
           {{ project.links?.github ? 'YES' : 'NO' }}
         </ProjectInfoItem>
-        <ProjectInfoItem :check-undefined="project.project_status?.version" title="Product readyness" bold text-size="18px">
+        <ProjectInfoItem
+          :check-undefined="project.project_status?.version" title="Product readyness" bold
+          text-size="18px"
+        >
           <template #prefix>
             <UnoIcon i-web-cube />
           </template>
@@ -79,7 +144,10 @@ const logo = props.project?.logos?.at(0)?.url
         </ProjectInfoItem>
       </div>
       <div grid grid-cols-2 gap-16px my-32px lg:grid-cols-4>
-        <ProjectInfoItem :check-undefined="project.blockchain_features?.network" tooltip-link="/" title="Ecosystem" bold>
+        <ProjectInfoItem
+          :check-undefined="project.blockchain_features?.network" tooltip-link="/" title="Ecosystem"
+          bold
+        >
           {{ project.blockchain_features?.network }}
         </ProjectInfoItem>
         <ProjectInfoItem invisible title="Last update" bold>

types/project.ts

@@ -143,3 +143,7 @@ export interface ProjectShallow {
   support?: number | undefined
   anonymity?: boolean | undefined
 }
+
+export interface ProjectIndexable extends Project {
+  [key: string]: any
+}