Welcome to GitPDF! π GitPDF is a unique tool that generates personalized PDF guides for GitHub commands and workflows. Whether you're onboarding a new team member, teaching GitHub basics, or creating a custom guide for yourself, GitPDF makes it simple and efficient! πΌβ¨
- π¨ Screenshots
- π Live Demo
- π Features
- π₯οΈ Tech Stack
- π Getting Started
- π Project Structure
- π€ Contributing
- π License
- β€οΈ Acknowledgments
- π Connect with Me
Check out the live demo here: π Git-PDf-Generator Live Demo π
- β¨ Personalized PDFs: Generate GitHub guides with the user's name for a personal touch.
- π Comprehensive GitHub Commands: Includes essential GitHub commands and workflows.
- π¨ Customizable Themes: Choose between light and dark themes for your PDF.
- β‘ Fast and Lightweight: Built with modern tools for quick and seamless performance.
- π Shareable PDFs: Easily share the generated PDFs with others.
- Frontend: React βοΈ
- Build Tool: Vite β‘
- Styling: TailwindCSS π¨
- PDF Generation: jsPDF π
- Icons: React Icons π
Follow these steps to run Git-PDF-Generator on your local machine:
git clone https://github.com/AlokKumarYadav2410/git-pdf-generator.git
cd git-pdf-generator
npm install
npm install tailwindcss @tailwindcss/vite
npm install @react-pdf/renderer
npm install react-hot-toast
npm install react-icons
npm run dev
Visit http://localhost:5173 to see GitPDF in action! π
or
http://localhost:5174
git-pdf-generator/
βββ public/ # Static assets
βββ src/
β βββ components/ # Reusable components (Footer, Header, etc.)
β βββ App.jsx # Main application file
β βββ index.css # Global styles
β βββ main.jsx # Entry point
βββ package.json # Project dependencies and scripts
βββ README.md # Project documentation
We welcome contributions! π οΈ If you'd like to improve GitPDF, follow these steps:
- Fork the repository.
- Create a new branch: git checkout -b feature-name.
- Make your changes and commit them: git commit -m "Add feature-name".
- Push to your branch: git push origin feature-name.
- Open a pull request.
- This project is licensed under the MIT License. See the LICENSE file for details.
- Built with love by Alok Kumar Yadav.
- Inspired by the need for simple and effective task management.
- Let's connect and collaborate!
- π§ Linkedin: ALOK KUMAR YADAV
- π GitHub: AlokKumarYadav2410
GitPDF: Simplify GitHub learning with personalized guides! β¨