Mamikos InvoiceGE

Mamikos InvoiceGE is a web-based invoice generator application built with Next.js 15, TypeScript, React, and the Shadcn UI library. It provides an easy way to create and manage professional invoices with support for Georgian language and templates.

Table of Contents

• Mamikos InvoiceGE
  • Table of Contents
  • Technologies
    • Core Technologies
    • Additional Dependencies
  • Roadmap
  • Demo
  • Getting Started
    • Prerequisites
    • Installation
  • 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

• Easily Create Invoices: Utilize a simple form to quickly generate invoices.
• Save for Future Access: Store your invoices directly in your browser for easy retrieval.
• Retrieve Invoices Effortlessly: Load and access invoices seamlessly from your saved list.
• Flexible Download Options: Download invoices directly or send them via email in PDF format.
• Template Variety: Choose from multiple (currently 3) invoice templates including a Georgian template.
• Live Preview: Edit the form and see changes in real-time with the live preview feature.
• 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 (English, German, Georgian).
• 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

Visit the live demo to see Mamikos InvoiceGE in action.

Getting Started

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

Prerequisites

• Node.js and npm installed on your system.

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/invoicege.git
   cd InvoiceGE

2. Install dependencies

   npm install

3. Create an .env.local file with this content (This step is for sending pdf to email feature):

   NODEMAILER_EMAIL=your_email@example.com
   NODEMAILER_PW=your_email_password

4. Start development server

   npm run dev

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

License

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