invoice-generator / README.md
anuragshas's picture
add: huggingface docker
619c141
---
title: Invoice Generator
emoji: 💻
colorFrom: gray
colorTo: green
sdk: docker
pinned: false
---
# Quotation Generator
This is a simple client-side application to generate quotations.
Fill in your company details, customer details, itemized list, and additional charges.
The application calculates totals and allows you to print or save the quotation as PDF.
## Usage
1. Open `index.html` in a web browser.
2. Enter your company and customer information.
3. Add item rows as needed (auto-generated S.No, description, HSN code, quantity, unit price, discount %).
4. Specify IGST rate and freight charges.
5. Fill in bank payment details.
6. Click **Generate Quotation**.
7. The formatted quotation appears with the total amount shown in words (Rupees and Paise, using Crore/Lakh notation) above the totals.
8. Click **Print / Save as PDF** to export.
## Running Tests
Ensure you have Node.js installed, then run:
```shell
npm test
```
Alternatively, to run the tests directly, use:
```shell
node tests/test.js
```
## Linting
Install the linting tools:
```shell
npm install
```
To run all linters (Stylelint, ESLint):
```shell
npm run lint
```
Or individually:
- `npm run lint:css`
- `npm run lint:js`
## Git Hooks (Husky)
Husky is configured to run tests, linters, and lint-staged automatically on each commit.
After installing dependencies, run:
```shell
npm run prepare
```
Now, any `git commit` will:
- run `npm test`
- run `npm run lint`
- run `lint-staged` to fix staged files