Cafe Management System - Documentation

Overview

The frontend of the Cafe Management System is built using Angular, a powerful and popular UI framework for developing single-page applications. The project incorporates various libraries and components to enhance the user experience and streamline development.

Cafe Management System - Documentation Frontend Documentation

Key Features

Responsive Design: Built with Angular Material, ensuring a consistent and visually appealing user interface.
Notifications: Snackbar used for displaying short messages or notifications.
Loading Indicators: Integrated ngx-ui-loader to provide loading animations during asynchronous operations.
Smooth Animations: Transitions and animations are used across the application for a seamless user experience.

Technologies and Libraries Used

1. Angular

Angular is the core UI framework used to build the application.
Version: 11.2.x

2. Snackbar

Used for displaying brief, actionable messages to users.

3. Angular Material UI

A library of reusable, high-quality UI components based on Google’s Material Design guidelines.
Provides a consistent design and interaction pattern for the application.

4. ngx-ui-loader

A spinner component used to display loading indicators during HTTP requests or other asynchronous operations.

Package.json

The package.json file manages the dependencies, scripts, and configurations for the Angular project. Below is the content of the file:

{
  "name": "frontend",
  "version": "0.0.0",
  "scripts": {
    "ng": "ng",
    "start": "node --openssl-legacy-provider ./node_modules/@angular/cli/bin/ng serve --o",
    "build": "ng build",
    "test": "ng test",
    "lint": "ng lint",
    "e2e": "ng e2e"
  },
  "private": true,
  "dependencies": {
    "@angular/animations": "~11.2.10",
    "@angular/cdk": "^11.2.13",
    "@angular/common": "~11.2.10",
    "@angular/compiler": "~11.2.10",
    "@angular/core": "^11.0.0",
    "@angular/flex-layout": "^11.0.0-beta.33",
    "@angular/forms": "~11.2.10",
    "@angular/material": "^11.2.13",
    "@angular/platform-browser": "~11.2.10",
    "@angular/platform-browser-dynamic": "~11.2.10",
    "@angular/router": "~11.2.10",
    "@types/file-saver": "^2.0.7",
    "file-saver": "^2.0.5",
    "jwt-decode": "^4.0.0",
    "ngx-ui-loader": "^11.0.0",
    "rxjs": "~6.6.0",
    "tslib": "^2.0.0",
    "zone.js": "~0.11.3"
  },
  "devDependencies": {
    "@angular-devkit/build-angular": "~0.1102.9",
    "@angular/cli": "~11.2.9",
    "@angular/compiler-cli": "~11.2.10",
    "@types/jasmine": "~3.6.0",
    "@types/node": "^12.11.1",
    "codelyzer": "^6.0.0",
    "jasmine-core": "~3.6.0",
    "jasmine-spec-reporter": "~5.0.0",
    "karma": "~6.1.0",
    "karma-chrome-launcher": "~3.1.0",
    "karma-coverage": "~2.0.3",
    "karma-jasmine": "~4.0.0",
    "karma-jasmine-html-reporter": "^1.5.0",
    "protractor": "~7.0.0",
    "ts-node": "~8.3.0",
    "tslint": "~6.1.0",
    "typescript": "~4.1.5"
  }
}

How to Run the Project

clone git repo:

git clone /~https://github.com/kumarswamy2025/Cafe-Management-System.git

Navigate to the frontend folder:
```
cd frontend
```
Install Dependencies:
```
npm install
```
Start the Development Server:
```
npm start
```
This command starts the Angular development server and opens the application in the default web browser.
Build for Production:
```
npm run build
```
This command creates an optimized production build of the application.

Additional Notes

Version Compatibility: Ensure you are using Node.js and npm versions compatible with Angular 11.

Credits

Framework: Angular
UI Library: Angular Material
Loader Component: ngx-ui-loader

Cafe Management System - Backend Documentation

Overview

The Café Management System is a full-stack web application designed to streamline the management of a café's day-to-day operations. The system integrates various features to handle billing, product management, user roles, and categories efficiently.

Technologies Used

Project Features and Components

Controllers

BillController: Manages billing operations, including generating, retrieving, and updating customer bills.
CategoryController: Handles operations related to menu categories, such as adding, updating, and deleting categories.
DashboardController: Provides an overview of café operations, including key performance indicators and summary reports.
ProductController: Manages product-related functionalities like adding new items, updating inventory, and deleting products.
UserController: Handles user authentication, role management, and CRUD operations for user accounts.

Routes

BillRoute: Defines API endpoints for billing operations.
CategoryRoute: Specifies routes for managing menu categories.
DashboardRoute: Configures endpoints to fetch and display dashboard data.
ProductRoute: Maps routes for product-related actions.
UserRoute: Contains endpoints for user authentication and account management.

Authentication and Security

JWT (JSON Web Token) is used to implement secure authentication mechanisms. Each user is issued a token for session validation, ensuring data security and authorized access to various features.

Database

Database Name: cafe_management_db
Tables:
- User: Stores user details like username, password (hashed), and roles.
- Category: Maintains a list of menu categories.
- Product: Tracks product information, including prices and inventory levels.
- Bill: Records billing details, such as customer transactions and total amounts.
Database System: MySQL

Additional Features

Role-Based Access Control: Provides differentiated access levels for admins, staff, and customers.
Dynamic Dashboard: Offers real-time analytics on sales, products, and customer activity.
Inventory Management: Tracks stock levels and notifies when supplies are running low.

This system ensures a smooth café management experience by combining robust backend logic, secure user authentication, and an organized database structure. It is scalable, secure, and designed to enhance operational efficiency for café businesses.

Folder Structure

backend/
│
├── src/
│   ├── controllers/          # API route handlers   
│        ├── BillController/    #BIll controller
│        ├── categoryController/ #Category controller
│        ├── dashboardController/ #Dashboard controller
│        ├── productController/  #Product controller
│        ├── userController/    #User controller
│   ├── routes/                # API routes for each endpoint
│       ├── BillRoute/    #BIll Route
│       ├── categoryRoute/ #Category Route
│       ├── dashboardRoute/ #Dashboard Route
│       ├── productRoute/  #Product Route
│       ├── userRoute/    #User Route
│  ├── services/                  # This folder contains service files
│    ├── AuthenticateToken/           # JWT authentication middleware
│    ├── checkRole/                #  This file contains user roles
│  └── server.js             # Main server file
├── config/                   # Configuration files (e.g., database, email credentials)
└── package.json              # Project dependencies and scripts

Setup Instructions

Navigate to the backend folder:
```
cd backend
```
Install dependencies:
```
npm install
```

Create a .env file and set up the environment variables (see .env example below).

# frontend URL
FRONTEND_URL="http://localhost:4200/"

# Server port
PORT=8080

# MySQL Database Connection
DB_HOST=localhost
DB_PORT=3306
DB_USERNAME=<your_db_username>
DB_PASSWORD=<your_db_password>
DB_NAME=cafe_management_db

# JWT Secret Key
ACCESS_TOKEN=<your_access_token_secret>

# Nodemailer credentials
EMAIL=<your_email>
PASSWORD=<your_email_password>

# Twilio Credentials
TWILIO_ACCOUNT_SID=<your_twilio_account_sid>
TWILIO_AUTH_TOKEN=<your_twilio_auth_token>
TWILIO_PHONE_NUMBER=<your_twilio_phone_number>

Run the backend server:
```
npm start
```

Database SQL Tables

User Table

CREATE TABLE user(
    id int primary key AUTO_INCREMENT,
    name varchar(250),
    contactnumber varchar(20),
    email varchar(50),
    password varchar(250),
    status varchar(20),
    role varchar(20),
    UNIQUE (email)
);

Category Table

CREATE TABLE category(
    id int not NULL AUTO_INCREMENT,
    name varchar(250) not NULL,
    primary key(id)
);

Product Table

CREATE TABLE product (
    id INT PRIMARY KEY AUTO_INCREMENT,
    name VARCHAR(255),
    categoryId INT,
    description VARCHAR(255),
    price INT,
    status VARCHAR(255)
);

Bill Table

CREATE TABLE bill (
    id INT PRIMARY KEY AUTO_INCREMENT,
    uuid VARCHAR(200),
    name VARCHAR(250),
    email VARCHAR(250),
    contactnumber VARCHAR(50),
    paymentMethod VARCHAR(50),
    total INT,
    productDetails JSON DEFAULT NULL,
    createdBy VARCHAR(255)
);

License

This project is licensed under the MIT License - see the LICENSE file for details.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Cafe Management System - Documentation

Overview

Cafe Management System - Documentation Frontend Documentation

Key Features

Technologies and Libraries Used

1. Angular

2. Snackbar

3. Angular Material UI

4. ngx-ui-loader

Package.json

How to Run the Project

Additional Notes

Credits

Cafe Management System - Backend Documentation

Overview

Technologies Used

Project Features and Components

Controllers

Routes

Authentication and Security

Database

Additional Features

Folder Structure

Setup Instructions

Database SQL Tables

User Table

Category Table

Product Table

Bill Table

License

Files

README.md

Latest commit

History

README.md

File metadata and controls

Cafe Management System - Documentation

Overview

Cafe Management System - Documentation Frontend Documentation

Key Features

Technologies and Libraries Used

1. Angular

2. Snackbar

3. Angular Material UI

4. ngx-ui-loader

Package.json

How to Run the Project

Additional Notes

Credits

Cafe Management System - Backend Documentation

Overview

Technologies Used

Project Features and Components

Controllers

Routes

Authentication and Security

Database

Additional Features

Folder Structure

Setup Instructions

Database SQL Tables

User Table

Category Table

Product Table

Bill Table

License