@20052507/dab-enterprise-bws 1.0.1

package/ERD_DFD_Documentation.md

@@ -0,0 +1,330 @@
+# DAB Enterprise Ltd - Business Web Solution (BWS)
+## ERD and DFD Documentation
+
+---
+
+## Entity Relationship Diagram (ERD)
+
+### Entities and Attributes:
+
+1. **Product**
+   - ProductID (PK)
+   - ProductName
+   - Category
+   - Quantity
+   - UnitPrice
+   - TotalPrice (Computed: Quantity * UnitPrice)
+
+2. **Sales**
+   - SalesID (PK)
+   - ProductID (FK)
+   - SoldQuantity
+   - SoldUnitPrice
+   - SoldTotalPrice (Computed: SoldQuantity * SoldUnitPrice)
+   - SalesDate
+
+3. **StockStatus**
+   - StockID (PK)
+   - ProductID (FK)
+   - AvailableQuantity
+   - SoldQuantity
+   - RemainingQuantity (Computed: AvailableQuantity - SoldQuantity)
+
+4. **User** (for authentication)
+   - UserID (PK)
+   - Username
+   - Password (encrypted)
+   - CreatedAt
+
+### Relationships:
+
+1. **Product → Sales**: One-to-Many
+   - One Product can have many Sales records
+   - ProductID in Sales references ProductID in Product
+
+2. **Product → StockStatus**: One-to-One
+   - One Product has one StockStatus
+   - ProductID in StockStatus references ProductID in Product
+
+### ERD Representation:
+
+```
+┌─────────────────────┐
+│      PRODUCT        │
+├─────────────────────┤
+│ ProductID (PK)      │◄──────────┐
+│ ProductName         │           │
+│ Category            │           │
+│ Quantity            │           │
+│ UnitPrice           │           │
+│ TotalPrice          │           │
+└─────────────────────┘           │
+         │                         │
+         │ 1                       │ 1
+         │                         │
+         │ N                       │ 1
+         ▼                         │
+┌─────────────────────┐           │
+│       SALES         │           │
+├─────────────────────┤           │
+│ SalesID (PK)        │           │
+│ ProductID (FK)      │           │
+│ SoldQuantity        │           │
+│ SoldUnitPrice       │           │
+│ SoldTotalPrice      │           │
+│ SalesDate           │           │
+└─────────────────────┘           │
+                                   │
+┌─────────────────────┐           │
+│    STOCKSTATUS      │───────────┘
+├─────────────────────┤
+│ StockID (PK)        │
+│ ProductID (FK)      │
+│ AvailableQuantity   │
+│ SoldQuantity        │
+│ RemainingQuantity   │
+└─────────────────────┘
+
+┌─────────────────────┐
+│       USER          │
+├─────────────────────┤
+│ UserID (PK)         │
+│ Username            │
+│ Password            │
+│ CreatedAt           │
+└─────────────────────┘
+```
+
+### Cardinalities:
+- Product to Sales: 1:N (One product can have multiple sales)
+- Product to StockStatus: 1:1 (One product has one stock status)
+- User: Independent entity for authentication
+
+---
+
+## Data Flow Diagram (DFD)
+
+### Level 0 DFD (Context Diagram):
+
+```
+┌─────────────────┐
+│     USER        │
+└────────┬────────┘
+         │
+         │ 1. Login/Logout
+         │ 2. Input Product Data
+         │ 3. Input Sales Data
+         │ 4. View Reports
+         ▼
+┌─────────────────────────────────┐
+│   DAB ENTERPRISE BWS SYSTEM     │
+│  (Business Web Solution)        │
+└─────────────────────────────────┘
+         │
+         │ 3. Display Reports
+         │ 4. Confirmation Messages
+         ▼
+┌─────────────────┐
+│   DATABASE      │
+└─────────────────┘
+```
+
+### Level 1 DFD:
+
+```
+┌─────────────────┐
+│     USER        │
+└────────┬────────┘
+         │
+         ├─────────────────────────────────────────┐
+         │                                         │
+         ▼                                         ▼
+┌─────────────────────┐                 ┌─────────────────────┐
+│  LOGIN PROCESS      │                 │  PRODUCT MANAGEMENT │
+│  1.0               │                 │  2.0               │
+├─────────────────────┤                 ├─────────────────────┤
+│ - Validate User     │                 │ - Add Product       │
+│ - Create Session    │                 │ - View Products     │
+│ - Encrypt Password  │                 │ - Update Product    │
+└─────────────────────┘                 │ - Delete Product    │
+         │                             └─────────────────────┘
+         │                                         │
+         └─────────────────┬───────────────────────┘
+                           │
+                           ▼
+                  ┌─────────────────────┐
+                  │   DATA STORE        │
+                  │   (Database)        │
+                  └─────────────────────┘
+                           │
+         ┌─────────────────┼─────────────────┐
+         │                 │                 │
+         ▼                 ▼                 ▼
+┌─────────────────────┐ ┌───────────────┐ ┌─────────────────┐
+│  SALES MANAGEMENT   │ │  STOCK STATUS │ │   REPORTS       │
+│  3.0               │ │  4.0          │ │   5.0           │
+├─────────────────────┤ ├───────────────┤ ├─────────────────┤
+│ - Add Sale          │ │ - View Stock  │ │ - Daily Sales    │
+│ - View Sales        │ │ - Update Stock│ │ - Stock Status  │
+│ - Update Sale       │ │ - Auto Calc   │ │ - Export Report │
+│ - Delete Sale       │ │               │ │                 │
+└─────────────────────┘ └───────────────┘ └─────────────────┘
+```
+
+### Process Descriptions:
+
+**Process 1.0 - Login Process**
+- Input: Username, Password
+- Process: Validate credentials, encrypt password, create session
+- Output: Session token, access granted/denied
+
+**Process 2.0 - Product Management**
+- Input: Product details (Name, Category, Quantity, UnitPrice)
+- Process: Calculate TotalPrice, validate data, store in database
+- Output: Product confirmation, updated product list
+
+**Process 3.0 - Sales Management**
+- Input: Sales details (ProductID, SoldQuantity, SoldUnitPrice, SalesDate)
+- Process: Calculate SoldTotalPrice, update stock, store sales record
+- Output: Sales confirmation, updated stock status
+
+**Process 4.0 - Stock Status**
+- Input: ProductID
+- Process: Calculate AvailableQuantity, SoldQuantity, RemainingQuantity
+- Output: Current stock status
+
+**Process 5.0 - Reports**
+- Input: Date range, report type
+- Process: Query database, aggregate data, format report
+- Output: Daily sales report, Stock status report
+
+---
+
+## Database Schema
+
+### MySQL Tables:
+
+```sql
+CREATE DATABASE db;
+USE db;
+
+-- Users Table
+CREATE TABLE users (
+    UserID INT AUTO_INCREMENT PRIMARY KEY,
+    Username VARCHAR(50) UNIQUE NOT NULL,
+    Password VARCHAR(255) NOT NULL,
+    CreatedAt TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Products Table
+CREATE TABLE products (
+    ProductID INT AUTO_INCREMENT PRIMARY KEY,
+    ProductName VARCHAR(100) NOT NULL,
+    Category VARCHAR(50) NOT NULL,
+    Quantity INT NOT NULL DEFAULT 0,
+    UnitPrice DECIMAL(10, 2) NOT NULL,
+    TotalPrice DECIMAL(10, 2) GENERATED ALWAYS AS (Quantity * UnitPrice) STORED,
+    CreatedAt TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Sales Table
+CREATE TABLE sales (
+    SalesID INT AUTO_INCREMENT PRIMARY KEY,
+    ProductID INT NOT NULL,
+    SoldQuantity INT NOT NULL,
+    SoldUnitPrice DECIMAL(10, 2) NOT NULL,
+    SoldTotalPrice DECIMAL(10, 2) GENERATED ALWAYS AS (SoldQuantity * SoldUnitPrice) STORED,
+    SalesDate DATE NOT NULL,
+    CreatedAt TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+    FOREIGN KEY (ProductID) REFERENCES products(ProductID) ON DELETE CASCADE
+);
+
+-- StockStatus Table
+CREATE TABLE stockstatus (
+    StockID INT AUTO_INCREMENT PRIMARY KEY,
+    ProductID INT UNIQUE NOT NULL,
+    AvailableQuantity INT NOT NULL DEFAULT 0,
+    SoldQuantity INT NOT NULL DEFAULT 0,
+    RemainingQuantity INT GENERATED ALWAYS AS (AvailableQuantity - SoldQuantity) STORED,
+    LastUpdated TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+    FOREIGN KEY (ProductID) REFERENCES products(ProductID) ON DELETE CASCADE
+);
+```
+
+---
+
+## Technology Stack
+
+### Backend:
+- Node.js (JavaScript Runtime)
+- Express.js (Web Framework)
+- MySQL (Database)
+- bcryptjs (Password Encryption)
+- express-session (Session Management)
+- cors (Cross-Origin Resource Sharing)
+- mysql2 (MySQL Driver)
+
+### Frontend:
+- React.js (UI Framework)
+- Tailwind CSS (Styling)
+- Axios (HTTP Client)
+- React Router (Navigation)
+
+---
+
+## Project Structure
+
+```
+FirstName_LastName_National_Practical_Exam_2026/
+├── backend-project/
+│   ├── config/
+│   │   └── database.js
+│   ├── controllers/
+│   │   ├── authController.js
+│   │   ├── productController.js
+│   │   ├── salesController.js
+│   │   └── stockController.js
+│   ├── middleware/
+│   │   └── authMiddleware.js
+│   ├── routes/
+│   │   ├── authRoutes.js
+│   │   ├── productRoutes.js
+│   │   ├── salesRoutes.js
+│   │   └── stockRoutes.js
+│   ├── server.js
+│   └── package.json
+├── frontend-project/
+│   ├── public/
+│   ├── src/
+│   │   ├── components/
+│   │   │   ├── Login.js
+│   │   │   ├── ProductForm.js
+│   │   │   ├── SalesForm.js
+│   │   │   ├── StockStatus.js
+│   │   │   ├── Reports.js
+│   │   │   └── Navbar.js
+│   │   ├── pages/
+│   │   │   ├── Products.js
+│   │   │   ├── Sales.js
+│   │   │   ├── Stock.js
+│   │   │   └── Dashboard.js
+│   │   ├── App.js
+│   │   └── index.js
+│   └── package.json
+└── ERD_DFD_Documentation.md
+```
+
+---
+
+## Implementation Notes
+
+1. **Password Security**: Using bcryptjs for password hashing with salt rounds of 10
+2. **Session Management**: Using express-session with secure cookie settings
+3. **CRUD Operations**:
+   - Products: Insert, Delete, Update, Retrieve (all operations)
+   - Sales: Insert only
+   - StockStatus: Insert only (auto-calculated)
+4. **Reports**: 
+   - Daily sales report: Aggregates sales by date
+   - Stock status report: Shows all products with current stock levels
+5. **Responsive Design**: Using Tailwind CSS for mobile-first responsive UI

package/README.md

@@ -0,0 +1,307 @@
+# DAB Enterprise Ltd - Business Web Solution (BWS)
+
+A comprehensive full-stack web application for managing products, sales, and inventory for DAB Enterprise Ltd located in Kigali City, Rwanda.
+
+## Project Overview
+
+This project addresses the inefficiencies of the manual paper-based system by providing a modern web-based solution for:
+- Product management
+- Sales tracking
+- Stock status monitoring
+- Report generation
+- User authentication
+
+## Technology Stack
+
+### Backend
+- **Node.js** - JavaScript runtime
+- **Express.js** - Web framework
+- **MySQL** - Database
+- **bcryptjs** - Password encryption
+- **express-session** - Session management
+- **cors** - Cross-Origin Resource Sharing
+- **mysql2** - MySQL driver
+
+### Frontend
+- **React.js** - UI framework
+- **Tailwind CSS** - Styling
+- **Axios** - HTTP client
+- **React Router** - Navigation
+
+## Project Structure
+
+```
+FirstName_LastName_National_Practical_Exam_2026/
+├── backend-project/
+│   ├── config/
+│   │   └── database.js
+│   ├── controllers/
+│   │   ├── authController.js
+│   │   ├── productController.js
+│   │   ├── salesController.js
+│   │   └── stockController.js
+│   ├── middleware/
+│   │   └── authMiddleware.js
+│   ├── routes/
+│   │   ├── authRoutes.js
+│   │   ├── productRoutes.js
+│   │   ├── salesRoutes.js
+│   │   └── stockRoutes.js
+│   ├── server.js
+│   └── package.json
+├── frontend-project/
+│   ├── public/
+│   │   └── index.html
+│   ├── src/
+│   │   ├── components/
+│   │   │   └── Navbar.js
+│   │   ├── pages/
+│   │   │   ├── Login.js
+│   │   │   ├── Dashboard.js
+│   │   │   ├── Products.js
+│   │   │   ├── Sales.js
+│   │   │   ├── Stock.js
+│   │   │   └── Reports.js
+│   │   ├── App.js
+│   │   ├── index.js
+│   │   └── index.css
+│   ├── tailwind.config.js
+│   ├── postcss.config.js
+│   └── package.json
+├── ERD_DFD_Documentation.md
+└── README.md
+```
+
+## Prerequisites
+
+Before running this application, ensure you have the following installed:
+
+1. **Node.js** (v14 or higher) - [Download here](https://nodejs.org/)
+2. **MySQL Server** (v5.7 or higher) - [Download here](https://dev.mysql.com/downloads/mysql/)
+3. **npm** (comes with Node.js)
+
+## Installation Instructions
+
+### 1. Database Setup
+
+The application automatically creates the database and tables on first run. However, ensure MySQL is running with the following default configuration:
+
+- **Host**: localhost
+- **User**: root
+- **Password**: (empty)
+
+If your MySQL has a different password, update the configuration in `backend-project/config/database.js` and `backend-project/server.js`.
+
+### 2. Backend Setup
+
+Navigate to the backend project directory:
+
+```bash
+cd backend-project
+```
+
+Install dependencies:
+
+```bash
+npm install
+```
+
+Start the backend server:
+
+```bash
+npm start
+```
+
+The backend will run on `http://localhost:5000`
+
+### 3. Frontend Setup
+
+Navigate to the frontend project directory:
+
+```bash
+cd frontend-project
+```
+
+Install dependencies:
+
+```bash
+npm install
+```
+
+Start the frontend development server:
+
+```bash
+npm start
+```
+
+The frontend will run on `http://localhost:3000`
+
+## Default Login Credentials
+
+The application creates a default admin user on first run:
+
+- **Username**: admin
+- **Password**: Admin@123
+
+**Important**: Change this password after first login for security.
+
+## Features
+
+### 1. Authentication
+- Session-based login system
+- Password encryption using bcrypt
+- Secure session management
+
+### 2. Product Management
+- Add new products
+- View all products
+- Edit product details
+- Delete products
+- Automatic total price calculation
+
+### 3. Sales Management
+- Record new sales
+- View sales history
+- Edit sales records
+- Delete sales records
+- Automatic stock update on sale
+
+### 4. Stock Status
+- View current stock levels
+- Real-time stock monitoring
+- Low stock alerts
+- Out of stock indicators
+
+### 5. Reports
+- **Daily Sales Report**: View sales summary by date
+- **Stock Status Report**: Complete inventory overview
+- Print functionality for reports
+
+## API Endpoints
+
+### Authentication
+- `POST /api/auth/login` - User login
+- `POST /api/auth/logout` - User logout
+- `GET /api/auth/check` - Check authentication status
+
+### Products
+- `GET /api/products` - Get all products
+- `GET /api/products/:id` - Get product by ID
+- `POST /api/products` - Create new product
+- `PUT /api/products/:id` - Update product
+- `DELETE /api/products/:id` - Delete product
+
+### Sales
+- `GET /api/sales` - Get all sales
+- `GET /api/sales/:id` - Get sale by ID
+- `POST /api/sales` - Create new sale
+- `PUT /api/sales/:id` - Update sale
+- `DELETE /api/sales/:id` - Delete sale
+- `GET /api/sales/report/daily` - Get daily sales report
+- `GET /api/sales/report/daily/details` - Get daily sales details
+
+### Stock Status
+- `GET /api/stock` - Get all stock status
+- `GET /api/stock/:id` - Get stock status by product ID
+- `GET /api/stock/report/status` - Get stock status report
+
+## Database Schema
+
+### Users Table
+- UserID (PK)
+- Username
+- Password (encrypted)
+- CreatedAt
+
+### Products Table
+- ProductID (PK)
+- ProductName
+- Category
+- Quantity
+- UnitPrice
+- TotalPrice (computed)
+- CreatedAt
+
+### Sales Table
+- SalesID (PK)
+- ProductID (FK)
+- SoldQuantity
+- SoldUnitPrice
+- SoldTotalPrice (computed)
+- SalesDate
+- CreatedAt
+
+### StockStatus Table
+- StockID (PK)
+- ProductID (FK)
+- AvailableQuantity
+- SoldQuantity
+- RemainingQuantity (computed)
+- LastUpdated
+
+## ERD and DFD
+
+Detailed Entity Relationship Diagram (ERD) and Data Flow Diagram (DFD) are available in `ERD_DFD_Documentation.md`.
+
+## Usage
+
+1. Start the MySQL server
+2. Start the backend server (`cd backend-project && npm start`)
+3. Start the frontend server (`cd frontend-project && npm start`)
+4. Open `http://localhost:3000` in your browser
+5. Login with default credentials (admin / Admin@123)
+6. Navigate through the application using the menu bar
+
+## Security Features
+
+- Password encryption using bcrypt (10 salt rounds)
+- Session-based authentication
+- Protected API routes
+- CORS configuration
+- SQL injection prevention (parameterized queries)
+
+## Responsive Design
+
+The application is fully responsive and works on:
+- Desktop computers
+- Tablets
+- Mobile devices
+
+## Troubleshooting
+
+### Backend won't start
+- Ensure MySQL is running
+- Check database credentials in `config/database.js`
+- Verify port 5000 is not in use
+
+### Frontend won't start
+- Ensure Node.js is installed
+- Check that dependencies are installed
+- Verify port 3000 is not in use
+
+### Database connection error
+- Verify MySQL server is running
+- Check username and password in database config
+- Ensure database `dab_enterprise_db` can be created
+
+## Project Removal
+
+After the assessment, to permanently remove the project:
+
+1. Stop both backend and frontend servers
+2. Delete the project folder: `FirstName_LastName_National_Practical_Exam_2026`
+3. Optionally, drop the database: `DROP DATABASE dab_enterprise_db;`
+
+**Note**: Always ask permission from the assessor before removing the project.
+
+## License
+
+This project was created for educational assessment purposes.
+
+## Contact
+
+For questions or issues related to this project, please contact the development team.
+
+---
+
+**Project completed for DAB Enterprise Ltd - National Practical Exam 2026**

package/backend-project/config/database.js

@@ -0,0 +1,13 @@
+const mysql = require('mysql2/promise');
+
+const pool = mysql.createPool({
+  host: 'localhost',
+  user: 'root',
+  password: '',
+  database: 'db',
+  waitForConnections: true,
+  connectionLimit: 10,
+  queueLimit: 0
+});
+
+module.exports = pool;

package/backend-project/controllers/authController.js

@@ -0,0 +1,67 @@
+const pool = require('../config/database');
+const bcrypt = require('bcryptjs');
+
+const login = async (req, res) => {
+  try {
+    const { username, password } = req.body;
+
+    if (!username || !password) {
+      return res.status(400).json({ message: 'Username and password are required' });
+    }
+
+    const [users] = await pool.query(
+      'SELECT * FROM users WHERE Username = ?',
+      [username]
+    );
+
+    if (users.length === 0) {
+      return res.status(401).json({ message: 'Invalid credentials' });
+    }
+
+    const user = users[0];
+    const isPasswordValid = await bcrypt.compare(password, user.Password);
+
+    if (!isPasswordValid) {
+      return res.status(401).json({ message: 'Invalid credentials' });
+    }
+
+    req.session.userId = user.UserID;
+    req.session.username = user.Username;
+
+    res.json({ 
+      message: 'Login successful', 
+      user: { 
+        userId: user.UserID, 
+        username: user.Username 
+      } 
+    });
+  } catch (error) {
+    console.error('Login error:', error);
+    res.status(500).json({ message: 'Server error' });
+  }
+};
+
+const logout = (req, res) => {
+  req.session.destroy((err) => {
+    if (err) {
+      return res.status(500).json({ message: 'Logout failed' });
+    }
+    res.json({ message: 'Logout successful' });
+  });
+};
+
+const checkAuth = (req, res) => {
+  if (req.session && req.session.userId) {
+    res.json({ 
+      authenticated: true, 
+      user: { 
+        userId: req.session.userId, 
+        username: req.session.username 
+      } 
+    });
+  } else {
+    res.json({ authenticated: false });
+  }
+};
+
+module.exports = { login, logout, checkAuth };