Skip to content

FAQ.md

Latest commit

 

History

History
309 lines (248 loc) · 10.1 KB

FAQ.md

File metadata and controls

309 lines (248 loc) · 10.1 KB

Resume Builder - Frequently Asked Questions (FAQ)

📋 General Questions

What is Resume Builder?

Resume Builder is a free, privacy-focused web application that allows you to create professional resumes directly in your browser. All your data stays on your device - no servers, no data collection, no privacy concerns.

Is Resume Builder really free?

Yes, completely free! There are no hidden costs, premium features, or subscription plans. The entire application is open-source and available for anyone to use.

Do I need to create an account?

While you can use the basic features without an account, creating a local account allows you to save multiple resumes and access them later. Your account data is stored locally in your browser, not on any server.

Is my data safe and private?

Absolutely! Your resume data never leaves your browser. Everything is stored locally using your browser's localStorage. We don't have servers collecting your information, and we don't track your usage.

🔐 Security & Privacy

How secure is my data?

Your data is very secure because:

  • All data stays in your browser (localStorage)
  • No data is transmitted to external servers
  • Input sanitization prevents XSS attacks
  • Rate limiting protects against brute force attempts
  • Content Security Policy headers prevent malicious scripts

What happens if I clear my browser data?

If you clear your browser's localStorage or cookies, your saved resumes will be lost. We recommend regularly exporting your resume data as a backup.

Can I use Resume Builder offline?

Yes! Once the page loads, you can use most features offline. However, PDF export requires an internet connection as it uses an external library.

Why do I get blocked from logging in?

For security, we implement rate limiting. After 5 failed login attempts, you'll be blocked for 15 minutes. This prevents brute force attacks on your account.

💾 Data Management

How do I backup my resume data?

Currently, you can export your resume as PDF. For complete data backup, you can:

  1. Export your resume in PDF format
  2. Copy your resume text to a document
  3. Use browser export features (if available)

Can I import data from other resume builders?

Currently, Resume Builder doesn't support importing from other platforms. You'll need to manually enter your information.

How much data can I store?

Browser localStorage typically allows 5-10MB per domain, which is enough for hundreds of resumes with text and basic formatting.

What happens if I use multiple browsers?

Each browser stores data independently. Your resume saved in Chrome won't be available in Firefox. Consider using one primary browser for consistency.

🎨 Features & Functionality

What resume templates are available?

Currently, Resume Builder offers:

  • Modern template with clean design
  • Classic template for traditional industries
  • Dark theme support for both templates

Can I customize the resume design?

You can:

  • Switch between light and dark themes
  • Choose different templates
  • Customize content sections
  • Adjust the layout through the form interface

How do I export my resume as PDF?

Click the "Download PDF" button in the header or preview section. The PDF will be generated and downloaded automatically.

Why isn't my PDF export working?

PDF export issues are usually caused by:

  • Poor internet connection (external library required)
  • Ad blockers blocking CDN resources
  • Browser security settings
  • Content Security Policy restrictions

Can I add a photo to my resume?

Currently, Resume Builder focuses on text-based resumes and doesn't support photo uploads. This keeps the application simple and privacy-focused.

🔧 Technical Issues

The application isn't loading properly

Try these steps:

  1. Clear your browser cache and cookies
  2. Disable browser extensions temporarily
  3. Try in incognito/private mode
  4. Use a different browser
  5. Check your internet connection

My changes aren't being saved

This usually indicates localStorage issues:

  1. Check if you're in private/incognito mode
  2. Ensure cookies and local storage are enabled
  3. Clear browser data and try again
  4. Check available storage space

I'm getting JavaScript errors

JavaScript errors can be caused by:

  1. Browser compatibility issues
  2. Conflicting browser extensions
  3. Corrupted cached files
  4. Network connectivity problems

The theme toggle isn't working

Theme issues are usually resolved by:

  1. Clearing browser cache
  2. Checking localStorage permissions
  3. Ensuring JavaScript is enabled
  4. Trying a different browser

🌐 Browser Compatibility

Which browsers are supported?

Resume Builder works on:

  • Chrome 80+ ✅
  • Firefox 75+ ✅
  • Safari 13+ ✅
  • Edge 80+ ✅

Does it work on mobile devices?

Yes! Resume Builder is fully responsive and works on:

  • iOS Safari
  • Android Chrome
  • Mobile Firefox
  • Other modern mobile browsers

Why doesn't it work on Internet Explorer?

Internet Explorer lacks support for modern JavaScript features used in Resume Builder. Please use a modern browser for the best experience.

🚀 Performance

Why is the application slow?

Performance issues can be caused by:

  • Slow internet connection (for initial load)
  • Large amounts of stored data
  • Browser extensions interfering
  • Outdated browser version
  • Insufficient device memory

How can I improve performance?

To optimize performance:

  1. Use the latest browser version
  2. Clear browser cache regularly
  3. Disable unnecessary extensions
  4. Close unused browser tabs
  5. Restart your browser periodically

🛠️ Development & Contribution

Is Resume Builder open source?

Yes! Resume Builder is open source under the MIT license. You can view the code, contribute improvements, or fork it for your own use.

How can I contribute?

You can contribute by:

  1. Reporting bugs or issues
  2. Suggesting new features
  3. Submitting code improvements
  4. Improving documentation
  5. Helping with translations (future feature)

Can I self-host Resume Builder?

Absolutely! Since it's a static web application, you can:

  1. Download the source code
  2. Host it on any web server
  3. Deploy to platforms like Netlify, Vercel, or GitHub Pages
  4. Run it locally for development

How do I report bugs?

Please report bugs through:

  1. GitHub Issues (preferred)
  2. Include browser version, OS, and steps to reproduce
  3. Provide console error messages if available
  4. Screenshots if the issue is visual

🔄 Updates & Maintenance

How often is Resume Builder updated?

Updates are released as needed for:

  • Bug fixes and security patches
  • New features and improvements
  • Browser compatibility updates
  • Performance optimizations

How do I get the latest version?

Since Resume Builder is web-based:

  1. Simply refresh the page to get updates
  2. Clear browser cache if you don't see changes
  3. Updates are deployed automatically

Will my data be compatible with updates?

Yes, we maintain backward compatibility. Your existing resume data will continue to work with new versions.

🎯 Best Practices

How do I create an effective resume?

Tips for a great resume:

  1. Keep it concise (1-2 pages)
  2. Use action verbs and quantify achievements
  3. Tailor content to the job you're applying for
  4. Proofread carefully for errors
  5. Use consistent formatting

What information should I include?

Essential resume sections:

  • Contact information
  • Professional summary
  • Work experience
  • Education
  • Skills
  • Relevant certifications or achievements

How do I make my resume ATS-friendly?

To optimize for Applicant Tracking Systems:

  1. Use standard section headings
  2. Include relevant keywords from job descriptions
  3. Use simple, clean formatting
  4. Avoid images, graphics, or complex layouts
  5. Save as PDF for consistent formatting

🆘 Getting Help

Where can I find more help?

Additional resources:

  • Documentation: Check ARCHITECTURE.md, API_DOCUMENTATION.md
  • Troubleshooting: See TROUBLESHOOTING.md for common issues
  • Security: Review SECURITY.md for security information
  • Development: See DEVELOPER_WORKFLOW.md for contributing

How do I contact support?

For support:

  1. Check this FAQ first
  2. Review the troubleshooting guide
  3. Search existing GitHub issues
  4. Create a new GitHub issue with details
  5. Follow the issue template for faster resolution

What information should I include when asking for help?

When seeking help, please provide:

  • Browser name and version
  • Operating system
  • Steps to reproduce the issue
  • Error messages from browser console
  • Screenshots if applicable
  • What you expected to happen vs. what actually happened

🔮 Future Features

What features are planned?

Potential future enhancements:

  • Additional resume templates
  • Cover letter builder
  • Multi-language support
  • Advanced customization options
  • Integration with job boards
  • Collaboration features

Can I request new features?

Yes! Feature requests are welcome:

  1. Check if the feature already exists in GitHub issues
  2. Create a new issue with the "feature request" label
  3. Describe the feature and its benefits
  4. Explain your use case

How are feature priorities determined?

Feature priorities are based on:

  • User demand and feedback
  • Technical feasibility
  • Alignment with project goals
  • Available development resources
  • Security and privacy considerations

📞 Quick Reference

Emergency Reset

If you're experiencing persistent issues:

// Open browser console and run:
localStorage.clear();
sessionStorage.clear();
location.reload();

Check Application Status

// Open browser console and run:
console.log('Security module:', typeof Security !== 'undefined');
console.log('Validation module:', typeof Validator !== 'undefined');
console.log('Current user:', localStorage.getItem('currentUser'));

Export Data Manually

// Open browser console and run:
const data = {};
for (let key in localStorage) {
  if (localStorage.hasOwnProperty(key)) {
    data[key] = localStorage[key];
  }
}
console.log(JSON.stringify(data, null, 2));
// Copy the output to save your data

Still have questions? Check our GitHub Issues or create a new issue for help!