MIT License

项目介绍

al1abb/invoify 是一个托管在 GitHub 上的开源项目,主要使用 TypeScript 编写,采用 MIT License 许可证,目前获得 6.4k 个 Star、747 次 Fork。

仓库全名
al1abb/invoify
开源许可证
MIT License
Star 数
6.4k
Fork 数
747
未关闭 Issue
40

README 摘要

Invoify Invoify is a free, web-based invoice generator built with Next.js, TypeScript, React and the shadcn/ui library. Fill in a form, pick a template, and get a real PDF. No account, no subscription, and nothing about your customers stored on a server. Table of Contents Invoify Table of Contents Features Your data stays in your browser Languages Technologies Core Technologies Additional Dependencies Demo Getting…

完整内容见 GitHub 原始 README 或本页 。

常见问题

invoify 用什么语言开发?

主要使用 TypeScript 编写,采用 MIT License 许可证,目前有 6.4k 个 Star。

invoify 可以免费商用吗?

仓库采用 MIT License 许可证,可免费使用与修改,商业使用请遵守许可证条款(例如保留版权声明与许可声明)。

如何获取 invoify 的源码?

可以直接克隆仓库:git clone https://github.com/al1abb/invoify.git;安装与运行步骤见仓库 README。

invoify 最近还在维护吗?

仓库最近一次更新为 8月24日,当前有 40 个未关闭 Issue;Star 数为 6.4k,可作为社区活跃度的参考。

关于

GitHub 原始描述(英文)

An invoice generator app built using Next.js, Typescript, and Shadcn

描述取自 GitHub 官方 API,保持仓库作者书写的原文。

简要分析

热度分
7902
价值分
4055
活跃状态
活跃

语言占比

CSS
Dockerfile
JavaScript
TypeScript

README

Discord CI

Invoify

Invoify is a free, web-based invoice generator built with Next.js, TypeScript, React and the shadcn/ui library. Fill in a form, pick a template, and get a real PDF. No account, no subscription, and nothing about your customers stored on a server.

Invoify Website image

Table of Contents

Features

  • 13 invoice templates: Classic, Modern, Sidebar, Bold Header, Minimal, Letterhead, Compact, Two-Tone, Bordered, Left Rail, Statement, Corner and Column.
  • Live preview: edit the form and watch the invoice update as you type.
  • Real PDFs: rendered with headless Chromium, not a screenshot of the page.
  • Email delivery: send the finished PDF straight to your client.
  • Save and reload: keep invoices in your browser and load them back later.
  • Address book: save senders and clients once, reuse them on every invoice.
  • Export: download the invoice data as JSON, CSV or XML.
  • Signatures, logos and custom line items, including per-invoice tax, discount and shipping.
  • 18 languages, for both the interface and the generated PDF.
  • Responsive: works on a phone as well as a desktop.

A walkthrough of what each part does lives on the guide page.

Your data stays in your browser

Invoify has no accounts and no database. Everything you enter (the address book, the autosave draft and your saved invoices) is stored locally, and it is encrypted at rest with AES-GCM 256 under a key the browser generates as non-extractable, so the key cannot be copied out of the origin.

Two things worth being clear about:

  • This protects you against someone reading the browser profile off disk: a shared or stolen machine, a filesystem backup, a synced profile, another OS account.
  • It does not protect against a script injected into the page, which holds the same key handle the app does. Defending against that would need a passphrase the app never stores.

The only time invoice data leaves your machine is when you generate a PDF or send one by email, and it is not retained afterwards.

Languages

Arabic, Azerbaijani, Catalan, Chinese (Simplified), English, French, German, Hebrew, Indonesian, Italian, Japanese, Norwegian (Bokmål), Norwegian (Nynorsk), Polish, Portuguese (Brazil), Serbian, Spanish and Turkish.

Right-to-left layouts are supported for Arabic and Hebrew. Some PDF translations are still incomplete and fall back to English.

Technologies

Core Technologies

  • Next.js 15: React framework for SSR and client-side navigation.
  • TypeScript: JavaScript superset with static typing.
  • Shadcn-UI: UI library for enhanced visuals.
  • Tailwind: Utility-first CSS framework.
  • React Hook Form: Form management for React.
  • Zod: TypeScript-first schema validation.
  • Puppeteer: PDF generation with headless browsers.
  • next-intl: Internationalized routing and messages.

Additional Dependencies

  • Nodemailer: Node.js module for sending emails.
  • Lucide Icons: Collection of customizable SVG icons.
  • Playwright: End-to-end tests.

Demo

Note 注意

Issue #11 reports PDF generation problems in Mozilla Firefox and is still open. The automated tests run against Chromium only, so the current state in Firefox is untested.

Visit the live demo to see Invoify in action.

Getting Started

Follow these instructions to get Invoify up and running on your local machine.

Prerequisites

  • Node.js 20 or later, and npm.

Installation

  1. Clone the repository:

    git clone https://github.com/al1abb/invoify.git
    cd invoify
    
  2. Install dependencies

    npm install
    
  3. Create an .env.local file. See Environment variables below. You can skip this if you do not need the “send PDF by email” feature.

  4. Start development server

    npm run dev
    
  5. Open your web browser and access the application at http://localhost:3000

Environment variables

All of these are optional; the app runs without them, minus the features they enable.

Variable Required for Notes
NODEMAILER_EMAIL Sending invoices by email The Gmail address that sends the mail.
NODEMAILER_PW Sending invoices by email A Gmail App Password, not your account password. Requires 2-Step Verification.

Development

Scripts

Command What it does
npm run dev Development server.
npm run build Production build.
npm run start Serve the production build.
npm run lint ESLint.
npm run format Prettier, writing in place.
npm run test:e2e Playwright end-to-end tests.
npm run test:e2e:ui The same tests in Playwright’s UI mode.
npm run analyze Production build with the bundle analyzer.
npx tsc --noEmit Typecheck.

predev and prebuild run scripts/build-pdf-css.mjs, which compiles the stylesheet the PDF renderer inlines. It runs automatically, so you only need npm run build:pdf-css if you change PDF styling and want to rebuild it on its own.

Tests

npx playwright install --with-deps chromium
npm run test:e2e

The suite builds and serves the production bundle, then runs against it in a desktop and a mobile viewport. CI runs the same typecheck, lint and test steps on every push and pull request. See .github/workflows/ci.yml.

License

Distributed under the MIT License. See LICENSE for more information.

Discord

Join the Discord server here

评论

暂无评论