Merge pull request #184 from arifszn/resume

Type definition for Resume feature

README.md

@@ -66,11 +66,11 @@
 ✓ [SEO](#seo)  
 ✓ [Avatar and Bio](#avatar-and-bio)  
 ✓ [Social Links](#social-links)  
-✓ [Skills](#skills)  
+✓ [Skill Section](#skills)  
-✓ [Experience](#experience)  
+✓ [Experience Section](#experience)  
-✓ [Education](#education)  
+✓ [Education Section](#education)  
-✓ [Projects](#projects)  
+✓ [Projects Section](#projects)  
-✓ [Blog Posts](#blog-posts)
+✓ [Blog Posts Section](#blog-posts)
 
 To view a live example, **[click here](https://arifszn.github.io/gitprofile)**.
 
@@ -205,9 +205,6 @@ const config = {
       projects: [], // These projects will not be displayed. example: ['my-project1', 'my-project2']
     },
   },
-  resume: {
-    fileName: 'resume.pdf', // Place the resume file in public folder with the same name as the 'fileName' property.
-  },
   social: {
     linkedin: '',
     twitter: '',
@@ -221,6 +218,9 @@ const config = {
     phone: '',
     email: '',
   },
+  resume: {
+    fileUrl: '', // Empty fileUrl will hide the `Download Resume` button.
+  },
   skills: ['JavaScript', 'React.js'],
   experiences: [
     {

gitprofile.config.js

@@ -10,9 +10,6 @@ const config = {
       projects: [], // These projects will not be displayed. example: ['my-project1', 'my-project2']
     },
   },
-  resume: {
-    fileName: 'resume.pdf', // Place the resume file in public folder with the same name as the 'fileName' property.
-  },
   social: {
     linkedin: 'ariful-alam',
     twitter: 'arif_szn',
@@ -26,6 +23,9 @@ const config = {
     phone: '',
     email: 'arifulalamszn@gmail.com',
   },
+  resume: {
+    fileUrl: 'resume.pdf', // Empty fileUrl will hide the `Download Resume` button.
+  },
   skills: [
     'PHP',
     'Laravel',

src/components/avatar-card/index.jsx

@@ -55,9 +55,9 @@ const AvatarCard = ({ profile, loading, avatarRing, resume }) => {
               : profile.bio}
           </div>
         </div>
-        {resume?.fileName && (
+        {resume?.fileUrl && (
           <a
-            href={resume.fileName}
+            href={resume.fileUrl}
             target="_blank"
             className="btn btn-outline btn-primary text-xs mt-6"
             download
@@ -75,7 +75,9 @@ AvatarCard.propTypes = {
   profile: PropTypes.object,
   loading: PropTypes.bool.isRequired,
   avatarRing: PropTypes.bool.isRequired,
-  resume: PropTypes.object,
+  resume: PropTypes.shape({
+    fileUrl: PropTypes.string,
+  }),
 };
 
 export default AvatarCard;

src/helpers/utils.jsx

@@ -144,9 +144,6 @@ export const sanitizeConfig = (config) => {
         projects: config?.github?.exclude?.projects || [],
       },
     },
-    resume: {
-      fileName: config?.resume?.fileName || false,
-    },
     social: {
       linkedin: config?.social?.linkedin,
       twitter: config?.social?.twitter,
@@ -160,6 +157,9 @@ export const sanitizeConfig = (config) => {
       phone: config?.social?.phone,
       email: config?.social?.email,
     },
+    resume: {
+      fileUrl: config?.resume?.fileUrl || '',
+    },
     skills: config?.skills || [],
     experiences: config?.experiences || [],
     education: config?.education || [],

types/index.d.ts

@@ -216,6 +216,10 @@ export interface Education {
   to?: string;
 }
 
+export interface Resume {
+  fileUrl?: string;
+}
+
 export interface Config {
   /**
    * GitHub Config
@@ -227,6 +231,11 @@ export interface Config {
    */
   social?: Social;
 
+  /**
+   * Resume
+   */
+  resume?: Resume;
+
   /**
    * Skill list
    */