README.md

USSD Simulator

The USSD Simulator is a web-based application designed to simulate the USSD code input and response process typically used on mobile phones. This project is built using Vue.js and Vue Router.

Note:

This project was developed using NALO (https://www.nalosolutions.com/ussd/) as the USSD provider. For other USSD providers, the code may need adjustments based on their specific implementation.

Table of Contents

• Features
• Demo
• Installation
  • Prerequisites
  • Getting Started
• Project Structure
• Usage
• Contributing
  • Branching and Pull Requests
• License
• Contact

Features

• Simulate USSD code input and response
• Dynamic response messages
• Responsive design

Demo

VUE_JS.mp4

Screenshots

Installation

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js (v12.x or later)
• npm (comes with Node.js) or Yarn

Getting Started

1. Clone the Repository

   git clone https://github.com/Anthony-cloud-1/ussd-simulator.git
   cd ussd-simulator/ussd-mock

2. Install Dependencies

   Using npm:

   npm install

   Or using Yarn:

   yarn install

3. Run the Application

   Using npm:

   npm run serve

   Or using Yarn:

   yarn serve

4. Build for Production

   Using npm:

   npm run build

   Or using Yarn:

   yarn build

Project Structure

ussd-mock/
│
├── public/
│   ├── index.html
│   └── ...
│
├── src/
│   ├── assets/
│   │   ├── phone_outline.png
|   |   ├── styles.css
|   |   ├── ussd.css
|   |   ├── tailwind.css
│   ├── components/
│   │   ├── HomeScreen.vue
|   |   └── UssdScreen.vue
│   ├── router/
│   │   └── index.js
│   ├── App.vue
│   └── main.js
│
├── .gitignore
├── babel.config.js
├── package.json
└── README.md

Usage

1. Navigate to the URL

   Open your browser and navigate to http://localhost:8080 (or the port specified in the console).

2. Interact with the USSD Simulator

   • Enter the USSD code in the input box and click the SEND button to simulate the request.
   • View the response message and either send a follow-up code or cancel the session.

Handling CORS Issue

During development, you may encounter CORS (Cross-Origin Resource Sharing) issues, especially when making requests from your local Vue.js application to a remote server. To resolve this, consider the following options:

1. Server-Side Solution (Preferred):

   • If you have control over the remote server (e.g., PHP backend), configure it to allow CORS headers. Add the following headers at the beginning of your PHP response:

     header("Access-Control-Allow-Origin: *"); // Allow all origins (adjust as needed)
     header("Access-Control-Allow-Methods: GET, POST, OPTIONS"); // Allow methods
     header("Access-Control-Allow-Headers: Content-Type, Authorization"); // Allow headers
     
     // Handle OPTIONS preflight requests
     if ($_SERVER['REQUEST_METHOD'] == 'OPTIONS') {
         exit(0);
     }

   • This approach ensures that the server explicitly allows requests from your development environment.

2. Client-Side Proxy Solution:

   • If modifying the server is not an option, set up a proxy server during development using a tool like http-proxy-middleware in your Vue.js project.
   • Install the http-proxy-middleware package:

     npm install http-proxy-middleware --save

   • Configure vue.config.js in your project's root directory (create one if not present):

     const { createProxyMiddleware } = require('http-proxy-middleware');
     
     module.exports = {
       devServer: {
         proxy: {
           '/api': {
             target: 'https://your-ussd-callback-url, // Replace with your server URL
             changeOrigin: true,
             pathRewrite: { '^/api': '' },
             secure: false,
           },
         },
       },
     };

   • Adjust your Axios requests in Vue.js to use the proxy path (/api/index.php instead of https://your-ussd-callback-url).

3. Temporary Solution (Not Recommended for Production):

   • For quick testing, you can use a browser extension to disable CORS. However, this introduces security risks and should only be used temporarily during development.

Contributing

We welcome contributions from the community! Here’s how you can get involved:

1. Fork the Repository

   Click the "Fork" button at the top right of the repository page.

2. Clone Your Fork

   git clone https://github.com/Anthony-cloud-1/ussd-simulator.git
   cd ussd-simulator/ussd-mock

3. Create a Branch

   git checkout -b feature-name

4. Make Your Changes

   Make the necessary changes in your forked repository.

5. Commit Your Changes

   git add .
   git commit -m "Description of changes"

6. Push to Your Fork

   git push origin feature-name

7. Create a Pull Request

   Go to the original repository and click on "New Pull Request" to submit your changes for review.

Branching and Pull Requests

• Branching: Always create a new branch for your feature or bug fix.

  git checkout -b feature-name

• Pull Requests: Ensure your branch is up to date with the base branch (usually main) before creating a pull request.

  git checkout main
  git pull origin main
  git checkout feature-name
  git merge main

  Then create a pull request from your feature branch to the main branch of the original repository.

License

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

Contact

For any questions or suggestions, please contact tonysack13@gmail.com.

---