Skip to content

Commit 1532cb2

Browse files
Updated documentation
Upgraded the README.md to apply to current's app state.
1 parent 47a6286 commit 1532cb2

File tree

1 file changed

+11
-21
lines changed

1 file changed

+11
-21
lines changed

README.md

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
The system allows creating, updating, filtering, and sorting products,
55
as well as tracking key metrics like total stock, inventory value, and average price.
66

7-
The project was built with a focus on usability, clear data visualization,
8-
responsiveness and its supposed to be bug free. It supports pagination,
9-
search filters, product availability toggling, and sorting by multiple columns.
7+
The project was built with a focus of usability, clear data visualization and
8+
responsiveness, for an easy convenience store inventory management (and It's supposed to be bug free).
9+
It supports pagination, search filters, product availability toggling, and sorting by multiple columns.
1010

1111
## Tech Stack
1212

@@ -16,21 +16,7 @@ search filters, product availability toggling, and sorting by multiple columns.
1616
- **Backend:** REST API with CRUD and stock control endpoints
1717
[InventoryManagerBS](https://github.com/technologic-technologic/InventoryManagerBS.git)
1818

19-
## Features
20-
21-
- **Product CRUD**
22-
23-
- **Filtering & Searching**
24-
25-
- **Sorting**
26-
27-
- **Stock Management**
28-
29-
- **Inventory Metrics**
30-
31-
- **Pagination**
32-
33-
## Backend API (Expected)
19+
## Backend API (Expected communications)
3420

3521
Business service git URL: https://github.com/technologic-technologic/InventoryManagerBS.git
3622

@@ -49,16 +35,20 @@ The frontend expects the following API endpoints:
4935

5036
To run the frontend locally:
5137

38+
```bash
39+
# go to directory from repo location
40+
cd inventory-manager
41+
```
5242
```bash
5343
# Install dependencies
5444
npm install
5545
```
5646
```bash
5747
# Run the app on port 8080
58-
npm start
48+
npm run dev
5949
```
6050

6151
```bash
62-
# Run all tests
63-
npm test
52+
# Run tests manually
53+
npm run test
6454
```

0 commit comments

Comments
 (0)