invoify - GitLite

KO | EN

gitlite — search

#ai #typescript #android #machine-learning #deep-learning #docker #java #cli #kubernetes #awesome-list #vue #security #ios #open-source

invoify

(★ 6,342)

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

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug_report.md
  - feature_request.md
- dependabot.yml
- - layout.tsx
  - page.tsx
- - index.ts
- globals.css
- layout.tsx
- not-found.tsx
- page.tsx
- robots.txt
- - alert-dialog.tsx
  - aspect-ratio.tsx
  - badge.tsx
  - button.tsx
  - calendar.tsx
  - card.tsx
  - dialog.tsx
  - form.tsx
  - input.tsx
  - label.tsx
  - navigation-menu.tsx
  - popover.tsx
  - scroll-area.tsx
  - select.tsx
  - skeleton.tsx
  - switch.tsx
  - table.tsx
  - tabs.tsx
  - textarea.tsx
  - toast.tsx
  - toaster.tsx
  - tooltip.tsx
  - use-toast.ts
- ChargesContext.tsx
- InvoiceContext.tsx
- Providers.tsx
- SignatureContext.tsx
- ThemeProvider.tsx
- TranslationContext.tsx
- useCurrencies.tsx
- useToasts.tsx
- - ar.json
  - ca.json
  - de.json
  - en.json
  - es.json
  - fr.json
  - id.json
  - it.json
  - ja.json
  - nb-NO.json
  - nn-NO.json
  - pl.json
  - pt-BR.json
  - sr.json
  - tr.json
  - zh-CN.json
- navigation.ts
- request.ts
- routing.ts
- fonts.ts
- helpers.ts
- schemas.ts
- seo.ts
- utils.ts
- variables.ts
.editorconfig
.gitignore
components.json
Dockerfile
LICENSE
middleware.ts
next.config.js
package-lock.json
package.json
postcss.config.js
puppeteer.config.cjs
README.md
tailwind.config.js
tailwind.config.ts
tsconfig.json
types.ts

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/al1abb/invoify

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd invoify

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

docker build -t invoify .

Dockerfile을 기반으로 실행 가능한 이미지를 빌드합니다.

docker run -p 8080:80 invoify

빌드된 이미지를 실제 컨테이너로 실행합니다.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

3. Node.js

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm run dev

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Discord](https://img.shields.io/badge/Discord-%40Invoify-000000?style=flat&logo=Discord&logoColor=#5865F2)](https://discord.gg/uhXKHbVKHZ)
# Invoify

Invoify is a web-based invoice generator application built with Next.js 13, TypeScript, React, and the Shadcn UI library. It provides an easy way to create and manage professional invoices.

![Invoify Website image](https://raw.githubusercontent.com/al1abb/invoify/master/public/assets/img/invoify-web-app.png)

## Table of Contents

- [Invoify](#invoify)
  - [Table of Contents](#table-of-contents)
  - [Technologies](#technologies)
    - [Core Technologies](#core-technologies)
    - [Additional Dependencies](#additional-dependencies)
  - [Roadmap](#roadmap)
  - [Demo](#demo)
  - [Getting Started](#getting-started)
    - [Prerequisites](#prerequisites)
    - [Installation](#installation)
  - [License](#license)

## Technologies

### Core Technologies

- **Next.js:** 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.

### Additional Dependencies

- **Nodemailer:** Node.js module for sending emails.
- **Lucide Icons:** Collection of customizable SVG icons.

## Roadmap

- [x] **Easily Create Invoices:** Utilize a simple form to quickly generate invoices.
- [x] **Save for Future Access:** Store your invoices directly in your browser for easy retrieval.
- [x] **Retrieve Invoices Effortlessly:** Load and access invoices seamlessly from your saved list.
- [x] **Flexible Download Options:** Download invoices directly or send them via email in PDF format.
- [x] **Template Variety:** Choose from multiple (currently 2) invoice templates.
- [x] **Live Preview:** Edit the form and see changes in real-time with the live preview feature.
- [x] **Export in Various Formats:** Export invoices in different formats, including JSON, XLSX, CSV, and XML.
- [ ] **I18N Support:** i18n support with multiple languages for UI and templates.
- [ ] **Themeable Templates:** Select a theme color for the invoice
- [ ] **Custom Inputs:** Define your own inputs that are missing from the default invoice builder. (Ex: VAT number)
- [ ] **Individual Tax for Line Items:** Add tax details for a specific line item other than the general tax

## Demo

> [!NOTE]
> Please be advised that there are currently issues when using this application in the Mozilla Firefox browser. For more information, refer to [Issue #11](https://github.com/aliabb01/invoify/issues/11).

Visit the [live demo](https://invoify.vercel.app) to see Invoify in action.

## Getting Started

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

### Prerequisites

- Node.js and npm installed on your system.

### Installation

1. Clone the repository:

```bash
   git clone https://github.com/al1abb/invoify.git
   cd invoify
   ```
2. Install dependencies
   
   ```bash
   npm install
   ```
3. Create an .env.local file with this content (This step is for sending pdf to email feature):
   ```env
   NODEMAILER_EMAIL=your_email@example.com
   NODEMAILER_PW=your_email_password
   ```
4. Start development server

```bash
    npm run dev
    ```
5. Open your web browser and access the application at [http://localhost:3000](http://localhost:3000)

## License

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

## Discord
Join the Discord server [here](https://discord.gg/uhXKHbVKHZ)