bitmutex/pulsebridge-gateway
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
pulsebridge-gateway/README.md
Amit Kumar Nandi 184ac10016
Update README.md
2024-03-04 00:48:41 +05:30

3.5 KiB
Raw Permalink Blame History

PulseBridge Gateway Server

buddy pipeline

Welcome to the PulseBridge Gateway Server repository! This server acts as an SMS Gateway powered by the PulseBridge library.The PulseBridge Gateway Server is a powerful SMS Gateway software that allows you to send SMS messages seamlessly. Whether you're looking to integrate SMS functionality into your web applications or send messages from a centralized server, PulseBridge Gateway makes the process efficient and straightforward.

Table of Contents

Getting Started

Follow these three simple steps to get started with PulseBridge Gateway:

  1. **Run PulseBridge Gateway Server App and click setup credentials button.
    Clone the repository, install dependencies, and run the server locally or using Docker Compose using the below instructions.Building and Running Locally

  2. Download PulseBridge Mobile App and set the URL in app provided by the server.

  3. Send SMS from the Server Frontend or API

    With the PulseBridge Gateway Server running, access the user-friendly interface at http://localhost to send SMS messages. Alternatively, integrate the SMS functionality into your applications using the provided API.

Building and Running Locally

  1. Clone the Repository:

    git clone https://github.com/aamitn/pulsebridge-gateway.git
cd pulsebridge-gateway

  2. Install Dependencies:
    *install composer from instructions here : Composer (getcomposer.org)

    composer install

  3. Run the Server: [run the dev server or copy the directory contents to web server of your choice]

    php -S localhost:8000 -t public

Running with Docker Compose

  • run command from the project root directory

  1. Run the Container:

    docker-compose up -d

Build your own docker image

  1. Build the Docker Image::

     docker build -t pulsebridge-gateway .

  2. Run the Docker Container:

    docker run -p 80:80 --name pulsebridge-gateway pulsebridge-gateway

License

This project is licensed under the MIT License.
 

Contributions

Contributions are welcome! If you'd like to contribute to PulseBridge Gateway, please follow our Contribution Guidelines.
Fork the repository and create your branch:

  1. bashCopy code

    git clone https://github.com/aamitn/pulsebridge-gateway.git cd pulsebridge-gateway git checkout -b feature/your-feature

  2. Make your changes and commit them:

    bashCopy code

    git add . git commit -m "Add your feature"

  3. Push to your fork and submit a pull request.

  4. Follow the code review process.

  5. Your contribution will be merged once approved.