Offline Invoice Generation System

🎨 Table of Contents

• Invoice Generation System
• Description
• Contributors
• Company Logo
• Badges
• Demo
• Installation
• How to Use the Project
• How to Contribute to the Project
• Include Credits
• License
• Security

Description

This project aims to provide a comprehensive solution for generating invoices using Electron.js, MySQL, and Node.js. It offers a user-friendly interface for managing invoices efficiently.

Contributors

• Parth Petkar
• Contributor Name
• Contributor Name
• Contributor Name

Company Logo

Badges

Installation

To install and run this project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/parthpetkar/Invoice-Generator-using-Electron.js
   

2. Navigate to the project directory:

   cd invoice_generator
   

3. Install dependencies:

   npm install
   

4. Set up MySQL database:

• Create a MySQL database and import the schema from database_schema.sql.

  create schema invoice;
  use invoice;
  CREATE TABLE `customers` (
     `customer_id` varchar(255) NOT NULL,
     `company_name` varchar(255) DEFAULT NULL,
     `address1` varchar(255) DEFAULT NULL,
     `address2` varchar(255) DEFAULT NULL,
     `address3` varchar(255) DEFAULT NULL,
     `gstin` varchar(255) DEFAULT NULL,
     `pan` varchar(255) DEFAULT NULL,
     `cin` varchar(255) DEFAULT NULL,
     PRIMARY KEY (`customer_id`)
  );
  
  CREATE TABLE `projects` (
     `customer_id` varchar(255) NOT NULL,
     `internal_project_id` varchar(255) NOT NULL,
     `project_name` varchar(255) DEFAULT NULL,
     `project_date` DATE DEFAULT NULL,
     `pono` varchar(255) DEFAULT NULL,
     `total_prices` decimal(10,2) DEFAULT NULL,
     `taxes` enum('CGST','SGST','IGST') DEFAULT NULL,
     PRIMARY KEY (`customer_id`,`internal_project_id`),
     CONSTRAINT `projects_ibfk_1` FOREIGN KEY (`customer_id`) REFERENCES `customers` (`customer_id`)
  );
  
  CREATE TABLE `milestones` (
     `customer_id` varchar(255) NOT NULL,
     `internal_project_id` varchar(255) NOT NULL,
     `milestone_id` varchar(255) NOT NULL,
     `milestone_name` varchar(255) DEFAULT NULL,
     `claim_percent` decimal(5,2) DEFAULT NULL,
     `amount` decimal(10,2) DEFAULT NULL,
     `pending` enum('yes','no') NOT NULL DEFAULT 'yes',
     PRIMARY KEY (`customer_id`,`internal_project_id`,`milestone_id`),
     CONSTRAINT `milestones_ibfk_1` FOREIGN KEY (`customer_id`, `internal_project_id`) REFERENCES `projects` (`customer_id`, `internal_project_id`)
  );
  CREATE TABLE `invoices` (
     `customer_id` VARCHAR(255) NOT NULL,
     `internal_project_id` VARCHAR(255) NOT NULL,
     `invoice_number` VARCHAR(255) NOT NULL,
     `company_name` VARCHAR(255) DEFAULT NULL,
     `project_name` VARCHAR(255) DEFAULT NULL,
     `invoice_date` DATE DEFAULT NULL,
     `due_date` DATE DEFAULT NULL,
     `total_prices` DECIMAL(10 , 2 ) DEFAULT NULL,
     `milestone_id` VARCHAR(255) NOT NULL,
     `milestone_name` VARCHAR(255) DEFAULT NULL,
     `status` ENUM('unpaid', 'paid') NOT NULL DEFAULT 'unpaid',
     `noti_send` enum('yes','no') NOT NULL DEFAULT 'no',
     PRIMARY KEY (`customer_id` , `internal_project_id` , `milestone_id`),
     CONSTRAINT `fk_projects` FOREIGN KEY (`customer_id` , `internal_project_id`)
        REFERENCES `projects` (`customer_id` , `internal_project_id`)
  );
  
  

• Update the MySQL connection details in .env.

  DB_HOST
  DB_USER
  DB_PASSWORD
  DB_DATABASE
  
  

5. Run the code

   npm run watch
   
   

How to Use the Project

To use the project, follow these steps:

1. Launch the application.
2. Create a new invoice by filling in the required details.
3. Save or print the generated invoice.

🛠️ Contribution guidelines for this project

We welcome contributions from the community! To contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/contribution).
3. Make your changes and commit them (git commit -am 'Add new feature').
4. Push to the branch (git push origin feature/contribution).
5. Create a new Pull Request.

License

This project is licensed under the MIT License.

Security

🔒 If you discover any security-related issues, please email parth.petkar221@vit.edu instead of using the issue tracker.