🚀 Career Pilot

An advanced AI-powered Resume Builder application, aimed to help users build their resumes with ease, backed by Modern Web Technologies and Artificial Intelligence.

👨‍💻 Maintainers

anurag3407

Mohnish27-dev

💻 Tech Stack

• Frontend: React 19, Vite
• Styling & Animations: TailwindCSS 4, Framer Motion
• Authentication & Backend: Firebase
• Core Libraries: jsPDF, html2canvas, socket.io-client, react-hook-form, @hello-pangea/dnd

✨ Features

• Modern Tech Stack: Built with React 19 and Vite for blazing fast development and optimized production builds.
• Stunning UI/UX: Styled using TailwindCSS 4, offering responsive and aesthetically pleasing design.
• Authentication: Secure Firebase Authentication integration.
• Smooth Animations: Powered by Framer Motion to provide delightful micro-interactions.
• PDF Generation: Export resumes reliably to PDF with jsPDF and html2canvas.
• Drag & Drop: Intuitive drag and drop interfaces using @hello-pangea/dnd and react-dropzone.
• Real-time Collaboration: Powered by socket.io-client for seamless live updates.
• Markdown Support: Enhanced text editing and formatting via react-markdown.
• Form Management: Robust form handling with react-hook-form and validation capabilities.

🛠️ Quick Start

Follow these steps to set up the project locally.

Prerequisites

• Node.js (v18+ recommended)
• npm

Installation

# Clone the repository
git clone https://github.com/anurag3407/career-pilot.git

# Navigate to the project directory
cd career-pilot

# Install frontend dependencies
npm install

Environment Setup

Copy the example environment file and add your configuration details.

cp .env.example .env

Ensure you configure the .env file with your Backend API and Firebase credentials as per .env.example.

Running the App

# Start development server
npm run dev

# Build for production
npm run build

# Preview production build locally
npm run preview

🌟 Contributing

We welcome and appreciate contributions from the community! Whether it's reporting bugs, improving documentation, or proposing new features, your help is valuable.

To make a contribution:

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

Please make sure to read our Contribution Guidelines and Code of Conduct before getting started.

🤝 Contributors

Thank you to everyone who has contributed to making Career Pilot better!

📄 License

This project is open-source. Please check the LICENSE file for more details.