Skip to content

MhmdFais/resume.io

Repository files navigation

Resume.io

Resume.io is a web application that allows users to create and customize their resumes easily. It provides a structured interface for entering personal, educational, professional, and project information. The app dynamically updates the resume preview as users input their data, making the process seamless and user-friendly.

Features

  • User-Friendly Interface: Simple and intuitive interface to enter personal, educational, work experience, skills, and project information.
  • Real-time Preview: View your resume as you build it, with immediate updates reflecting any changes.
  • Modular Sections: Navigate between different sections like Personal Info, Education, Experience, Skills, Projects, and Contact Info.
  • Responsive Design: The application is fully responsive, providing a smooth experience on both desktop and mobile devices.
  • Data Persistence: Your data remains intact as you move between different sections of the resume builder.
  • Final Resume Preview: View the complete resume before finalizing it, ensuring all information is accurate and well-formatted.

Demo

Check out the live version of the project here

Tech Stack

  • Frontend:
    • React.js
    • CSS Modules for component-specific styling
  • State Management:
    • React Context API for managing global state
  • Deployment:
    • Vercel for continuous deployment and hosting

Acknoledgement

Installation

Clone the repository:

git clone https://github.com/your-username/resume-io.git
cd resume-io

Install dependencies:

npm install

Running the App Locally To run the development server, use the following command:

npm start

The app will be available at http://localhost:3000.

Deployment

This project is automatically deployed to Vercel with every push to the main branch. To manually deploy, you can use:

vercel --prod
Make sure you have Vercel CLI installed.

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/my-feature)
  3. Commit your changes (git commit -am 'Add my feature')
  4. Push to the branch (git push origin feature/my-feature)
  5. Open a Pull Request.