inventrack 3.0.0

package/README.md

@@ -0,0 +1,25 @@
+# Inventory Management System
+A responsive web-based dashboard for managing products, categories, suppliers, and purchase orders. The system tracks inventory levels, generates low-stock alerts, records activity logs, and provides reports such as inventory value and stock insights. Built with HTML, CSS, Bootstrap, JavaScript, and a fake REST API using json-server.
+
+This project has been restructured into a frontend for the user interface and a backend for data management.
+
+## Project Structure
+
+- `frontend/`: Contains all the client-side code, including HTML, CSS, and JavaScript.
+- `backend/`: Contains the server-side code, primarily using `json-server` to serve a REST API from a `db.json` file.
+
+## Setup and Installation
+
+To set up and run this project locally, follow the instructions below for both the frontend and backend.
+
+### Frontend
+
+Refer to the `frontend/README.md` for detailed instructions on setting up and running the frontend application.
+
+### Backend
+
+Refer to the `backend/README.md` for detailed instructions on setting up and running the backend API.
+
+## Deployment
+
+This project is configured for deployment on Vercel. See the [Vercel deployment section](#vercel-deployment) for more details.

package/api/index.js

@@ -0,0 +1,13 @@
+const jsonServer = require("json-server");
+const path = require("path");
+const server = jsonServer.create();
+
+const dbPath = path.resolve(__dirname, "../backend/data/db.json");
+const router = jsonServer.router(dbPath);
+const middlewares = jsonServer.defaults();
+
+server.use(middlewares);
+server.use(jsonServer.rewriter({ "/api/*": "/$1" }));
+server.use(router);
+
+module.exports = server;

package/backend/README.md

@@ -0,0 +1,35 @@
+# Backend - Inventory Management System
+
+This directory contains the server-side code for the Inventory Management System. It primarily uses `json-server` to provide a fake REST API based on the `db.json` file.
+
+## Technologies Used
+
+- Node.js
+- `json-server` (for creating a fake REST API)
+
+## Setup and Running Locally
+
+1.  **Install Dependencies:**
+    Navigate to the `backend` directory and install the necessary Node.js packages:
+    ```bash
+    cd backend
+    npm install
+    ```
+
+2.  **Start the JSON Server:**
+    Once dependencies are installed, you can start the JSON server:
+    ```bash
+    npm start
+    ```
+    This will typically start the server on `http://localhost:3000` (or another port if 3000 is in use), serving your `db.json` file as a REST API.
+
+## API Endpoints
+
+The `db.json` file defines the data structure and available endpoints. Common endpoints will include:
+
+- `/products`
+- `/categories`
+- `/suppliers`
+- `/orders`
+
+Refer to the `json-server` documentation for more details on interacting with the API.