Repository files navigation

• 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

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.

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

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 fromdatabase_schema.sql.

  createschemainvoice;use invoice;CREATETABLE `customers` (`customer_id`varchar(255)NOT NULL,`company_name`varchar(255) DEFAULTNULL,`address1`varchar(255) DEFAULTNULL,`address2`varchar(255) DEFAULTNULL,`address3`varchar(255) DEFAULTNULL,`gstin`varchar(255) DEFAULTNULL,`pan`varchar(255) DEFAULTNULL,`cin`varchar(255) DEFAULTNULL,PRIMARY KEY (`customer_id`));CREATETABLE `projects` (`customer_id`varchar(255)NOT NULL,`internal_project_id`varchar(255)NOT NULL,`project_name`varchar(255) DEFAULTNULL,`project_date`DATE DEFAULTNULL,`pono`varchar(255) DEFAULTNULL,`total_prices`decimal(10,2) DEFAULTNULL,`taxes` enum('CGST','SGST','IGST') DEFAULTNULL,PRIMARY KEY (`customer_id`,`internal_project_id`),CONSTRAINT`projects_ibfk_1`FOREIGN KEY (`customer_id`)REFERENCES`customers` (`customer_id`));CREATETABLE `milestones` (`customer_id`varchar(255)NOT NULL,`internal_project_id`varchar(255)NOT NULL,`milestone_id`varchar(255)NOT NULL,`milestone_name`varchar(255) DEFAULTNULL,`claim_percent`decimal(5,2) DEFAULTNULL,`amount`decimal(10,2) DEFAULTNULL,`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`));CREATETABLE `invoices` (`customer_id`VARCHAR(255)NOT NULL,`internal_project_id`VARCHAR(255)NOT NULL,`invoice_number`VARCHAR(255)NOT NULL,`company_name`VARCHAR(255) DEFAULTNULL,`project_name`VARCHAR(255) DEFAULTNULL,`invoice_date`DATE DEFAULTNULL,`due_date`DATE DEFAULTNULL,`total_prices`DECIMAL(10 ,2 ) DEFAULTNULL,`milestone_id`VARCHAR(255)NOT NULL,`milestone_name`VARCHAR(255) DEFAULTNULL,`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_HOSTDB_USERDB_PASSWORDDB_DATABASE

5. Run the code

   npm run watch

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.

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.

This project is licensed under theMIT License.

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