https://github.com/bmlt-enabled/yap

Find meetings or someone to talk to over the phone leveraging a BMLT root server.
https://github.com/bmlt-enabled/yap

Last synced: 3 months ago
JSON representation

Find meetings or someone to talk to over the phone leveraging a BMLT root server.

• Host: GitHub
• URL: https://github.com/bmlt-enabled/yap
• Owner: bmlt-enabled
• License: mit
• Created: 2017-04-15T18:28:45.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-03-25T10:44:50.000Z (3 months ago)
• Last Synced: 2024-03-25T12:54:44.800Z (3 months ago)
• Language: PHP
• Homepage: https://bmlt.app/yap
• Size: 23.4 MB
• Stars: 10
• Watchers: 3
• Forks: 9
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Lists

• awesome-bmlt - yap - Find meetings or someone to talk to over the phone leveraging a BMLT root server. (BMLT (Basic Meeting List Toolbox))

README

        
yap











 


  

 





The purposes of yap are :

* To be able to take the results of a BMLT root server and play it back through the telephone.  

* To be able to set up routing rules for zip codes and helpline numbers with optional extension dialing.

We are taking advantage of using Twilio which essentially handles all the VOIP parts.  You provision a number, set up an application, and point it your PHP server.

# Documentation

For setup instructions and general documentation please visit [https://yap.bmlt.app](https://yap.bmlt.app)

# Downloads

* Latest Releases: [https://github.com/bmlt-enabled/yap/releases](https://github.com/bmlt-enabled/yap/releases)

* Bleeding Edge: [https://archives.bmlt.app/index.html#yap](https://archives.bmlt.app/index.html#yap)

# ⚠️ Major Refactor

Currently we are in the process of doing a major overhaul of the codebase, by migrating all the legacy PHP to a more Laravel-like structure.  This will improve the stability and maintainability.  Also, as part of this change, we are making the code more testable which will help us track code paths more effectively.  We also plan to redo the frontend part of it migrating from a Bootstrap/Jquery structure to React.

All the legacy components has been migrated.  We are doing some final testing now.

In a future release we will refactor the frontend by building a new React application to consume the rebuilt APIs, that work has partially started but has been put on pause.

# API Docs (WIP)

This only works locally right now.

1. Run `make swagger`.

2. Browse to `/api/documentation`

# Testing

After cloning, add a file called `.env.testing` with the value `GOOGLE_MAPS_API_KEY=`.  Then run `make test`.

To run code coverage, you can run `make coverage`.