Skip to content

Latest commit

 

History

History
101 lines (58 loc) · 2.31 KB

README.md

File metadata and controls

101 lines (58 loc) · 2.31 KB

ResumeCraft

ResumeCraft is an AI-powered resume builder designed to help users create professional, customized resumes with ease. By leveraging AI, ResumeCraft ensures that each resume is tailored to highlight the user’s skills, experience, and achievements effectively.

✨ Features

  • AI-Powered Resume Generation: Generate a professional resume using AI.

  • User Authentication: Secure login and registration with Clerk.

  • Real-Time Preview: See live updates as you fill out the resume form.

  • Easy Customization: Edit sections like experience, education, skills, and more.

  • Save and Share: Save your resume and share a link with potential employers.

  • Responsiveness: Ensures the application adapts seamlessly to various screen sizes and devices.

⚙️ Tech Stack

  • Frontend: Next.js 14.2.5

  • Authentication: Clerk

  • AI Integration: Gemini API

  • Styling: TailwindCSS

  • Backend: Node.js

  • Database: MongoDB

Getting Started

Prerequisites

  • Node.js (v22.0 or later) and npm (v6 or later) installed on your computer.

Installation

  1. Clone the Repository

    git clone https://github.com/exclusiveabhi/ai-resume-builder.git

  2. Navigate to the Project Directory

    cd ai-resume-builder

  3. Install Dependencies

    npm install

  4. Start the application

    npm run dev

    The app will be running on http://localhost:3000.

  5. Configure Environment Variables

    Create a .env.local file in the root directory and set the required environment variables. Refer to .env.local.example for the required necessary details.

Contributing

If you would like to contribute to ResumeCraft, please follow these steps:

  1. Fork the Repository

  2. Create a New Branch

    git checkout -b feature/YourFeatureName

  3. Make Your Changes

  4. Commit Your Changes

    git commit -am 'Add new feature'

  5. Push to the Branch

    git push origin feature/YourFeatureName

  6. Create a Pull Request

Contact

For any questions or feedback, please open an issue on the GitHub repository.