ReceiptCraft ReceiptCraft is a web-based tool designed to simplify the management, generation, and analysis of CVS-style receipt data. It leverages a structured product database (e.g., cvs-products-2025-05-03.json) to store and process details such as product names, SKUs, prices, and descriptions. Users can create, customize, save, and manage receipts in real-time, with features for product catalog management and receipt preview. Features
Product Database Management: Store and retrieve product details from a JSON file. Receipt Generation: Create and customize CVS-style receipts with real-time previews. Saved Receipts: View and manage previously generated receipts. Product Management: Add, edit, and delete products in the catalog. Extensible Format: Easily update the product database with new items.
Getting Started Prerequisites
Node.js (for running the web app) Git for cloning the repository A modern web browser Optional: A text editor like VS Code
Installation
Clone the Repository: git clone https://github.com/exee21/ReceiptCraft.git cd ReceiptCraft
Install Dependencies:Install required Node.js packages: npm install
Set Up the Product Database:
Ensure the cvs-products-2025-05-03.json file is in the project root or a designated data directory. Example JSON structure:[ { "name": "Viviscal™ Dry Shampoo", "sku": "022600200079", "price": "9.99", "description": "" }, ... ]
Usage
Run the Application:Start the web app locally with: npm start
Alternatively, access the live version at https://goodtryhoe-receipt.replit.app.
Example Workflow:
Navigate to the "Create Receipt" tab to generate a new receipt. Add products using the "Product Entry" form and customize with "Template Customization." Save the receipt and view it under "Saved Receipts." Manage products via the "Manage Products" tab.
Output:
Receipts are displayed in the browser with a real-time preview. Saved receipts are listed with options to view details.
Project Structure
cvs-products-2025-05-03.json: Product database with names, SKUs, prices, and descriptions. index.html / index.js: Main files for the web app (update based on your structure). images/: Folder for screenshots (e.g., 2025-05-03 06.27.58 goodtryhoe-receipt.replit.app 6992b92a2b20.png). README.md: This file. package.json: List of Node.js dependencies.
Contributing Contributions are welcome! To contribute:
Fork the repository. Create a new branch (git checkout -b feature/your-feature). Make your changes and commit (git commit -m "Add your feature"). Push to your branch (git push origin feature/your-feature). Open a Pull Request with a clear description of your changes.
Please follow the Code of Conduct and ensure your code adheres to the project’s style guidelines. License This project is licensed under the MIT License. See the LICENSE file for details. Contact For questions or suggestions, reach out via GitHub Issues or contact the maintainer at receiptcraft@cleveroncommand.com Acknowledgments
Product data sourced from retail listings (e.g., Target.com, Amazon.com). Built with Node.js and hosted on Replit. Web app available at https://goodtryhoe-receipt.replit.app.