easy-invoice-pdf/README.md
Vlad Sazonau 5a4e9debc1
feat: add /?template=stripe|default to url, implement URL compression logic (#130)
* feat: add debug local storage UI and update README; include new template parameter handling in invoice form

* feat: add URL compression logic when generating link to invoice to reduce url length + add unit tests + improved existing e2e tests

* ci: remove type check step from unit tests workflow to streamline CI process

* test: update e2e tests for Stripe invoice sharing logic and template; increase timeout for visibility checks

* test: refactor e2e tests for invoice generation and sharing; update element selectors and enhance URL disallow rules in robots.txt

* chore: enhance README with detailed features and update about page references; add GitHub star CTA component

* chore: update configuration files for Prettier, run prettify across the project

* chore: run dedupe

* test: add e2e tests for Open Graph meta tags in invoice templates; verify correct rendering for default and Stripe templates

* chore: remove @stagewise/toolbar-next package and related development toolbar component from the project
2025-08-20 01:15:48 +02:00

74 lines
3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🧾 [EasyInvoicePDF](https://easyinvoicepdf.com)
> Free & Open-Source Invoice Generator. Create professional invoices instantly in your browser with live preview, multiple templates, and no sign-up required. **[Try it now → easyinvoicepdf.com](https://easyinvoicepdf.com)**
## Features
-**Live Preview**: See changes in real-time as you type
- 🔗 **Shareable Links**: Send invoices directly to clients without attachments
-**No Sign-Up Required**: Start creating invoices immediately without any registration
- 📱 **Browser Only**: No server uploads, your data stays private
- 🌍 **Multi-Language**: Support for 10+ languages and all major currencies
- 🧮 **European VAT**: Automatic VAT calculation and formatting
- 🎨 **Multiple Templates**: Including modern **Stripe-style design**
- 📄 **Instant PDF**: One-click download ready for printing or sending
**❤️ Support the project**: [Buy me a coffee](https://buymeacoffee.com/vladsazon) to help keep EasyInvoicePDF free and open-source!
#### Default Invoice Template
<img width="1440" height="769" alt="default template" src=".github/screenshots/default.png" />
#### Stripe Invoice Template
<img width="1440" height="769" alt="stripe template" src=".github/screenshots/stripe-tmp.png" />
## Demo Video 🎥
Watch a quick demo of EasyInvoicePDF in action to see how easy it is to create professional invoices in seconds. The video demonstrates key features like live preview, instant PDF download, and customization options.
https://github.com/user-attachments/assets/9e3194e0-3072-4c95-ae99-e66db1301dc6
## Tech Stack
- [React](https://react.dev/)
- [TypeScript](https://www.typescriptlang.org/)
- [Next.js](https://nextjs.org/)
- [TailwindCSS](https://tailwindcss.com/)
- [shadcn/ui](https://ui.shadcn.com/)
- [Origin UI](https://originui.com/)
- [@react-pdf/renderer](https://github.com/diegomura/react-pdf)
## Other Tools & Services
- Generate beautiful OG images: https://og.new
- Analytics: https://umami.is/
## Quick Start
- Run `pnpm i`
- Copy `.env.example to .env.local` (`cp .env.example .env.local`)
- Run `pnpm run dev`
For the full app experience, youll need to obtain and set values from the following services:
- [Resend](https://resend.com/)
- [Upstash](https://upstash.com/)
- [Google Drive API](https://developers.google.com/workspace/drive/api/quickstart/js)
- [Telegram Bot API](https://core.telegram.org/bots)
## License
This project is dual-licensed:
- **AGPL-3.0** (for open-source or compliant use): [GNU AGPL v3](https://www.gnu.org/licenses/agpl-3.0.html)
- **Commercial license** (for proprietary use): contact [vlad@mail.easyinvoicepdf.com](mailto:vlad@mail.easyinvoicepdf.com)
By using this software, you agree to the terms of the applicable license.
## GitAds Sponsored
<!-- GitAds-Verify: JHXPD28PWARXHPOAHBA7ZTVRIFBKGZPE -->
Ads help support this project 🙏
[![Sponsored by GitAds](https://gitads.dev/v1/ad-serve?source=vladsez/easy-invoice-pdf@github)](https://gitads.dev/v1/ad-track?source=vladsez/easy-invoice-pdf@github)