parthpetkar/invoice-generator-using-electron.js

This project was created for the company Inclined Engineering and Consultancy for managing their Invoices.

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` (
     `company_name` varchar(255) DEFAULT NULL,
     `address` varchar(255) DEFAULT NULL,
     `phone` varchar(20) DEFAULT NULL,
     `gstin` varchar(20) DEFAULT NULL,
     `pan` varchar(20) DEFAULT NULL,
     `cin` varchar(20) NOT NULL,
     PRIMARY KEY (`cin`)
  ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
  
  CREATE TABLE `projects` (
     `cin` varchar(20) NOT NULL,
     `pono` varchar(20) NOT NULL,
     `total_prices` decimal(10,2) DEFAULT NULL,
     `taxes` enum('GST','IGST') DEFAULT NULL,
     `project_name` varchar(255) DEFAULT NULL,
     PRIMARY KEY (`cin`,`pono`),
     CONSTRAINT `projects_ibfk_1` FOREIGN KEY (`cin`) REFERENCES `customers` (`cin`)
  ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
  
  CREATE TABLE `milestones` (
     `cin` varchar(20) NOT NULL,
     `pono` varchar(20) NOT NULL,
     `milestone_name` varchar(255) NOT NULL,
     `claim_percent` decimal(5,2) DEFAULT NULL,
     `amount` decimal(10,2) DEFAULT NULL,
     PRIMARY KEY (`cin`,`pono`,`milestone_name`),
     CONSTRAINT `milestones_ibfk_1` FOREIGN KEY (`cin`, `pono`) REFERENCES `projects` (`cin`, `pono`)
  ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci
  

• 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 [email protected] instead of using the issue tracker.

invoice-generator-using-electron.js's Issues

Create Customer input field CSS needs to be improved

Create Templete of invoice generation

Block System to display customers

Customer Creation Backend

Do with Mysql

Update the tables

Add better css

Manage Customer Pagination has bugs

Remove Font Awesome Icons

Remove the Font Awesome Icons and personal icons

Create Customer Backend

Create Invoice Page not done properly

Create customer Form incomplete

Center the next and previous buttons. Add a save button for each step and align it to the bottom right. The steps menu on the top center align it. Initially, when the browser is loaded even though taxes are not the tax type is displayed. In the milestone step, add space in the buttons. Also for the next and previous buttons if there is no last page the button should be disabled, and likewise for the next button.

Keep the theme Blue - White only.

Menu Bug

When we click on create customer we move to the next page after that the menu messes up

Create Invoice Backend

Create Sql queries for backend

Add Milestone Page