Project Description : The Retail Invoice Management System is a comprehensive software solution designed to streamline and automate invoice data management in the retail industry. The system offers a set of powerful subsystems that enable efficient handling of invoices, data extraction, storage, search, analysis, and export. It simplifies the entire invoice processing workflow, from importing physical invoices to generating customized reports and integrating with other software applications.
For functions include function name - Action Performed ie console.log(functionName + "Action Performed" );## Project Onboarding Documentation
Welcome to the team! This document serves as a guide to help you get up to speed with our project and understand the technologies and processes involved. By following the steps outlined below, you'll be ready to contribute effectively in no time.
The project is a web application built using a combination of JavaScript, HTML, and CSS for the front-end, Node.js with Express for the back-end, and SQL for the database.
Prerequisites Before diving into the project, make sure you have the following software and tools installed on your machine:
Node.js: Download and install Node.js from the official website. MySql: mysql community server , mysql Javascript
Setting up the Project Follow the steps below to set up the project locally:
Clone the project repository from vcs Navigate to the project's root directory in your terminal or command prompt. Run npm install to install the project dependencies. create a .env file to store your sql's credentials
Running the Application To run the application locally, perform the following steps: start the sql server Go to Project's root directiory 'npm run devStart' In a new terminal go to /html/ 'http-server' Navigate to url provided in terminal
Development Workflow Our project follows a standard development workflow. Familiarize yourself with the following steps: Branching: Create a new branch for each feature or bug fix you are working on. Testing: Write unit tests for new features and ensure existing tests pass. Code Review: Submit a pull request for your changes and request a code review from a team member. Deployment: After the pull request is approved, the changes will be merged and deployed to the staging or production environment.
Some Extensions to make your work easier prettier - code formatter