|
| 1 | +# Configuration Guide |
| 2 | + |
| 3 | +This portfolio uses a centralized configuration system that allows you to update all your personal information, contact details, and content from a single file. |
| 4 | + |
| 5 | +## 📍 Main Configuration File |
| 6 | + |
| 7 | +**File Location:** `src/config/personal.ts` |
| 8 | + |
| 9 | +This file contains ALL your personal information that appears throughout the portfolio. You only need to edit this one file to update your entire website! |
| 10 | + |
| 11 | +## 🎯 What You Can Update |
| 12 | + |
| 13 | +### 1. Basic Information |
| 14 | +```typescript |
| 15 | +name: 'Your Full Name', |
| 16 | +firstName: 'Your First Name', |
| 17 | +title: 'Your Professional Title', |
| 18 | +tagline: 'Your professional tagline or description', |
| 19 | +``` |
| 20 | + |
| 21 | +### 2. Contact Information |
| 22 | +```typescript |
| 23 | +contact: { |
| 24 | + email: 'your.email@example.com', |
| 25 | + phone: '+1 (555) 123-4567', |
| 26 | + location: 'Your City, Country', |
| 27 | +}, |
| 28 | +``` |
| 29 | + |
| 30 | +### 3. Social Media Links |
| 31 | +```typescript |
| 32 | +social: { |
| 33 | + github: 'https://github.com/yourusername', |
| 34 | + linkedin: 'https://linkedin.com/in/yourusername', |
| 35 | + twitter: 'https://twitter.com/yourusername', |
| 36 | + instagram: '', // Optional - leave empty if you don't want to show |
| 37 | + youtube: '', // Optional - leave empty if you don't want to show |
| 38 | + website: 'https://yourwebsite.com', |
| 39 | +}, |
| 40 | +``` |
| 41 | + |
| 42 | +### 4. Professional Information |
| 43 | +```typescript |
| 44 | +professional: { |
| 45 | + yearsOfExperience: 3, |
| 46 | + currentRole: 'Your Current Job Title', |
| 47 | + currentCompany: 'Your Current Company', |
| 48 | + specializations: ['Skill 1', 'Skill 2', 'Skill 3'], |
| 49 | + bio: 'Your professional bio - this appears on the About page', |
| 50 | +}, |
| 51 | +``` |
| 52 | + |
| 53 | +### 5. Personal Interests |
| 54 | +Update your interests that appear on the About page: |
| 55 | +```typescript |
| 56 | +about: { |
| 57 | + interests: [ |
| 58 | + { |
| 59 | + title: 'Interest Title', |
| 60 | + description: 'Description of your interest', |
| 61 | + icon: '🌟', // Emoji icon |
| 62 | + }, |
| 63 | + // Add more interests... |
| 64 | + ], |
| 65 | +}, |
| 66 | +``` |
| 67 | + |
| 68 | +### 6. Experience Timeline |
| 69 | +Update your work and education history: |
| 70 | +```typescript |
| 71 | +experience: [ |
| 72 | + { |
| 73 | + year: '2024', |
| 74 | + title: 'Your Job Title', |
| 75 | + company: 'Company Name', |
| 76 | + description: 'What you did in this role', |
| 77 | + type: 'work', // 'work' or 'education' |
| 78 | + }, |
| 79 | + // Add more experiences... |
| 80 | +], |
| 81 | +``` |
| 82 | + |
| 83 | +### 7. SEO & Metadata |
| 84 | +```typescript |
| 85 | +seo: { |
| 86 | + title: 'Your Name - Portfolio', |
| 87 | + description: 'Brief description for search engines', |
| 88 | + keywords: ['keyword1', 'keyword2', 'keyword3'], |
| 89 | + ogImage: '/path/to/your/image.jpg', |
| 90 | +}, |
| 91 | +``` |
| 92 | + |
| 93 | +## 📁 Other Files You Might Want to Update |
| 94 | + |
| 95 | +### Projects (`src/utils/constants.ts`) |
| 96 | +To add or modify your projects: |
| 97 | +1. Open `src/utils/constants.ts` |
| 98 | +2. Edit the `projects` array |
| 99 | +3. Add your project images to the `public/assets/` folder |
| 100 | + |
| 101 | +### Skills (`src/utils/constants.ts`) |
| 102 | +To update your skills and their proficiency levels: |
| 103 | +1. Open `src/utils/constants.ts` |
| 104 | +2. Edit the `skills` array |
| 105 | +3. Adjust the `level` (0-100) for each skill |
| 106 | + |
| 107 | +## 🚀 Deployment Instructions |
| 108 | + |
| 109 | +### 1. GitHub Pages Deployment |
| 110 | + |
| 111 | +1. **Push your changes to GitHub:** |
| 112 | + ```bash |
| 113 | + git add . |
| 114 | + git commit -m "Update personal information" |
| 115 | + git push origin main |
| 116 | + ``` |
| 117 | + |
| 118 | +2. **Set up GitHub Pages:** |
| 119 | + - Go to your repository on GitHub |
| 120 | + - Click on "Settings" tab |
| 121 | + - Scroll down to "Pages" section |
| 122 | + - Select "GitHub Actions" as the source |
| 123 | + - The deployment will start automatically |
| 124 | + |
| 125 | +3. **Set up environment variables (for contact form):** |
| 126 | + - Go to your repository on GitHub |
| 127 | + - Click on "Settings" tab |
| 128 | + - Click on "Secrets and variables" → "Actions" |
| 129 | + - Add a new secret named `REACT_APP_LAMBDA_ENDPOINT` |
| 130 | + - Set the value to your AWS Lambda endpoint URL |
| 131 | + |
| 132 | +### 2. AWS Lambda Setup (for Contact Form) |
| 133 | + |
| 134 | +If you want the contact form to work, you need to set up an AWS Lambda function: |
| 135 | + |
| 136 | +1. **Create a Lambda function** with the following code: |
| 137 | + ```javascript |
| 138 | + const nodemailer = require('nodemailer'); |
| 139 | + |
| 140 | + exports.handler = async (event) => { |
| 141 | + // Your Lambda function code here |
| 142 | + // See your existing Lambda setup |
| 143 | + }; |
| 144 | + ``` |
| 145 | + |
| 146 | +2. **Get the Lambda endpoint URL** and add it to GitHub Secrets as `REACT_APP_LAMBDA_ENDPOINT` |
| 147 | + |
| 148 | +### 3. Custom Domain (Optional) |
| 149 | + |
| 150 | +To use a custom domain: |
| 151 | +1. Add a `CNAME` file to the `public` folder with your domain name |
| 152 | +2. Configure DNS settings with your domain provider |
| 153 | +3. Update the `website` URL in `personal.ts` |
| 154 | + |
| 155 | +## 🔧 Development Commands |
| 156 | + |
| 157 | +```bash |
| 158 | +# Install dependencies |
| 159 | +npm install |
| 160 | + |
| 161 | +# Start development server |
| 162 | +npm start |
| 163 | + |
| 164 | +# Build for production |
| 165 | +npm run build |
| 166 | + |
| 167 | +# Deploy to GitHub Pages |
| 168 | +npm run deploy |
| 169 | +``` |
| 170 | + |
| 171 | +## 📝 Quick Update Checklist |
| 172 | + |
| 173 | +When updating your portfolio: |
| 174 | + |
| 175 | +- [ ] Update personal information in `src/config/personal.ts` |
| 176 | +- [ ] Replace profile image: `public/assets/AkhilDP2.jpeg` |
| 177 | +- [ ] Update projects in `src/utils/constants.ts` |
| 178 | +- [ ] Add project images to `public/assets/` |
| 179 | +- [ ] Update skills and their levels in `src/utils/constants.ts` |
| 180 | +- [ ] Test locally with `npm start` |
| 181 | +- [ ] Commit and push changes to trigger deployment |
| 182 | + |
| 183 | +## 🐛 Troubleshooting |
| 184 | + |
| 185 | +**Build fails?** |
| 186 | +- Check for syntax errors in `personal.ts` |
| 187 | +- Make sure all required fields are filled |
| 188 | +- Verify image paths exist |
| 189 | + |
| 190 | +**Contact form not working?** |
| 191 | +- Check if `REACT_APP_LAMBDA_ENDPOINT` is set in GitHub Secrets |
| 192 | +- Verify your Lambda function is working |
| 193 | +- Check browser console for errors |
| 194 | + |
| 195 | +**Deployment fails?** |
| 196 | +- Check GitHub Actions logs |
| 197 | +- Verify Node.js version compatibility |
| 198 | +- Make sure all dependencies are properly installed |
| 199 | + |
| 200 | +## 📞 Need Help? |
| 201 | + |
| 202 | +If you run into issues: |
| 203 | +1. Check the browser console for errors |
| 204 | +2. Review GitHub Actions logs for deployment issues |
| 205 | +3. Make sure all file paths are correct |
| 206 | +4. Verify all required fields in `personal.ts` are filled |
| 207 | + |
| 208 | +--- |
| 209 | + |
| 210 | +**Remember:** After making changes to `src/config/personal.ts`, the entire website will automatically update with your new information! |
0 commit comments