103 lines
2.6 KiB
Markdown
103 lines
2.6 KiB
Markdown
# 📄 **Resume Builder**
|
|
|
|
A free, easy-to-use, and customizable resume builder that lets you create professional resumes quickly. Built with **React**, **TypeScript**, and **TailwindCSS**, this tool provides various templates and export options to help you land your dream job. 🚀
|
|
|
|
|
|
|
|
## 🛠 **Features**
|
|
|
|
- **✨ Multiple Templates**: Choose from a variety of modern, professional templates.
|
|
- **🎨 Customizable**: Tailor your resume by editing sections, fonts, and colors.
|
|
- **📥 Export Options**: Download your resume in **PDF** or **DOCX** format.
|
|
- **⚡ Fast & Free**: No sign-ups required, just quick and easy resume creation.
|
|
- **💻 Built with Modern Tech**: Leveraging **React**, **TypeScript**, and **TailwindCSS**.
|
|
|
|
|
|
|
|
## 🌐 **Tech Stack**
|
|
|
|
- **React**: For building a dynamic and interactive UI.
|
|
- **TypeScript**: Adds static types for better developer experience and error reduction.
|
|
- **TailwindCSS**: A utility-first CSS framework for responsive and customizable designs.
|
|
- **Vite**: A fast build tool and development server.
|
|
|
|
|
|
|
|
## 🚀 **Installation**
|
|
|
|
Clone the repository and install dependencies to get started:
|
|
|
|
```bash
|
|
git clone https://github.com/eshanized/resume.git
|
|
cd resume
|
|
pnpm install
|
|
```
|
|
|
|
|
|
|
|
## 🏗 **Development**
|
|
|
|
To start the development server, run:
|
|
|
|
```bash
|
|
pnpm run dev
|
|
```
|
|
|
|
Your app will be available at `http://localhost:3000`.
|
|
|
|
|
|
|
|
## 🛠 **Building**
|
|
|
|
To build the project for production:
|
|
|
|
```bash
|
|
pnpm run build
|
|
```
|
|
|
|
The build will be available in the `dist` folder.
|
|
|
|
|
|
|
|
## 📦 **Exporting Your Resume**
|
|
|
|
Once you've created your resume:
|
|
|
|
1. Edit the template to your liking.
|
|
2. Click on the **Export** button to download your resume in either **PDF** or **DOCX** format.
|
|
|
|
|
|
|
|
## 💻 **Usage**
|
|
|
|
- Open the app and choose a template 🖌.
|
|
- Fill in your personal details, work experience, education, and skills 💼.
|
|
- Customize your resume with font choices, color themes, and section adjustments 🎨.
|
|
- Export your resume when you're happy with the result 📥.
|
|
|
|
|
|
|
|
## 💬 **Contributing**
|
|
|
|
We welcome contributions! 🎉 If you find any bugs or have suggestions for improvements, feel free to create an issue or open a pull request.
|
|
|
|
|
|
|
|
## 📝 **License**
|
|
|
|
This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for more details.
|
|
|
|
|
|
|
|
## 📧 **Contact**
|
|
|
|
If you have any questions or feedback, feel free to reach out:
|
|
|
|
- Email: [m.eshanized@gmail.com](mailto:m.eshanized@gmail.com)
|
|
- GitHub: [https://github.com/eshanized](https://github.com/eshanized)
|
|
|
|
|
|
|
|
## 🌟 **Acknowledgments**
|
|
|
|
A special thanks to the open-source community and all contributors! 🙏 |