From bad4e76bcf3e7873acbe82f40c963ff0ed98c4c1 Mon Sep 17 00:00:00 2001 From: Leonardo Trevizo Date: Wed, 15 Oct 2025 20:23:33 -0600 Subject: [PATCH] Updated documentation Upgraded the README.md to apply to current's app state. Signed-off-by: Leonardo Trevizo --- README.md | 32 +++++++++++--------------------- 1 file changed, 11 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index cd9dcb6..989cfd6 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ The system allows creating, updating, filtering, and sorting products, as well as tracking key metrics like total stock, inventory value, and average price. -The project was built with a focus on usability, clear data visualization, -responsiveness and its supposed to be bug free. It supports pagination, -search filters, product availability toggling, and sorting by multiple columns. +The project was built with a focus of usability, clear data visualization and +responsiveness, for an easy convenience store inventory management (and It's supposed to be bug free). +It supports pagination, search filters, product availability toggling, and sorting by multiple columns. ## Tech Stack @@ -16,21 +16,7 @@ search filters, product availability toggling, and sorting by multiple columns. - **Backend:** REST API with CRUD and stock control endpoints [InventoryManagerBS](https://github.com/technologic-technologic/InventoryManagerBS.git) -## Features - -- **Product CRUD** - -- **Filtering & Searching** - -- **Sorting** - -- **Stock Management** - -- **Inventory Metrics** - -- **Pagination** - -## Backend API (Expected) +## Backend API (Expected communications) Business service git URL: https://github.com/technologic-technologic/InventoryManagerBS.git @@ -49,16 +35,20 @@ The frontend expects the following API endpoints: To run the frontend locally: +```bash +# go to directory from repo location +cd inventory-manager +``` ```bash # Install dependencies npm install ``` ```bash # Run the app on port 8080 -npm start +npm run dev ``` ```bash -# Run all tests -npm test +# Run tests manually +npm run test ```