-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a rather more useful README and LICENSE
- Loading branch information
Showing
2 changed files
with
48 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2020 Nexmo | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,79 +1,45 @@ | ||
<p align="center"><img src="https://res.cloudinary.com/dtfbvvkyp/image/upload/v1566331377/laravel-logolockup-cmyk-red.svg" width="400"></p> | ||
# Laravel Messages | ||
|
||
<p align="center"> | ||
<a href="https://travis-ci.org/laravel/framework"><img src="https://travis-ci.org/laravel/framework.svg" alt="Build Status"></a> | ||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/d/total.svg" alt="Total Downloads"></a> | ||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/v/stable.svg" alt="Latest Stable Version"></a> | ||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/license.svg" alt="License"></a> | ||
</p> | ||
<img src="https://developer.nexmo.com/assets/images/Vonage_Nexmo.svg" height="48px" alt="Nexmo is now known as Vonage" /> | ||
|
||
## About Laravel | ||
> (If you're here looking for the older `laravel-sms` project, check out the v1 tag on this repo) | ||
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as: | ||
Laravel Messages is a very simple demo app to show a Messages API integration with Laravel 7. It receives and responds to WhatsApp messages, sends Messages to a whitelisted number, and logs the incoming status events. | ||
|
||
- [Simple, fast routing engine](https://laravel.com/docs/routing). | ||
- [Powerful dependency injection container](https://laravel.com/docs/container). | ||
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage. | ||
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent). | ||
- Database agnostic [schema migrations](https://laravel.com/docs/migrations). | ||
- [Robust background job processing](https://laravel.com/docs/queues). | ||
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting). | ||
## Welcome to Vonage | ||
|
||
Laravel is accessible, powerful, and provides tools required for large, robust applications. | ||
<!-- change "github-repo" at the end of the link to be the name of your repo, this helps us understand which projects are driving signups so we can do more stuff that developers love --> | ||
|
||
## Learning Laravel | ||
If you're new to Vonage, you can [sign up for an account](https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=github-repo) and get some free credit to get you started. | ||
|
||
Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework. | ||
## Set Up the Project | ||
|
||
If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains over 1500 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library. | ||
We've tried to keep things short and sweet! | ||
|
||
## Laravel Sponsors | ||
* Clone this repo and run `composer install`. | ||
* Copy `.env.example` to `.env`, add your credentials to the `NEXMO_*` fields at the bottom. | ||
* Run your application with `php artisan serve`. | ||
* If you're working locally, run [ngrok](https://ngrok.com) to expose the port locally; copy the URL. | ||
* On the [Dashboard](https://dashboard.nexmo.com), go to the Messages API Sandbox, and whitelist your phone for WhatsApp. | ||
* On the same page, configure the webhook URLs for incoming messages and status events: | ||
- incoming messages should be `[url you copied earlier]/webhook/inbound` | ||
- status webhooks should go to `[url you copied earlier]/webhook/status` | ||
|
||
We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel [Patreon page](https://patreon.com/taylorotwell). | ||
You're all set! | ||
|
||
- **[Vehikl](https://vehikl.com/)** | ||
- **[Tighten Co.](https://tighten.co)** | ||
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)** | ||
- **[64 Robots](https://64robots.com)** | ||
- **[Cubet Techno Labs](https://cubettech.com)** | ||
- **[Cyber-Duck](https://cyber-duck.co.uk)** | ||
- **[Many](https://www.many.co.uk)** | ||
- **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)** | ||
- **[DevSquad](https://devsquad.com)** | ||
- [UserInsights](https://userinsights.com) | ||
- [Fragrantica](https://www.fragrantica.com) | ||
- [SOFTonSOFA](https://softonsofa.com/) | ||
- [User10](https://user10.com) | ||
- [Soumettre.fr](https://soumettre.fr/) | ||
- [CodeBrisk](https://codebrisk.com) | ||
- [1Forge](https://1forge.com) | ||
- [TECPRESSO](https://tecpresso.co.jp/) | ||
- [Runtime Converter](http://runtimeconverter.com/) | ||
- [WebL'Agence](https://weblagence.com/) | ||
- [Invoice Ninja](https://www.invoiceninja.com) | ||
- [iMi digital](https://www.imi-digital.de/) | ||
- [Earthlink](https://www.earthlink.ro/) | ||
- [Steadfast Collective](https://steadfastcollective.com/) | ||
- [We Are The Robots Inc.](https://watr.mx/) | ||
- [Understand.io](https://www.understand.io/) | ||
- [Abdel Elrafa](https://abdelelrafa.com) | ||
- [Hyper Host](https://hyper.host) | ||
- [Appoly](https://www.appoly.co.uk) | ||
- [OP.GG](https://op.gg) | ||
- [云软科技](http://www.yunruan.ltd/) | ||
## Run the Project | ||
|
||
## Contributing | ||
Visit `[url of project]/messages` and enter the number of the whitelisted phone (in E163 format, e.g. 447770007777. You should get a WhatsApp message. | ||
|
||
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions). | ||
## Getting Help | ||
|
||
## Code of Conduct | ||
We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either: | ||
|
||
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct). | ||
* Open an issue on this repository | ||
* Tweet at us! We're [@VonageDev on Twitter](https://twitter.com/VonageDev) | ||
* Or [join the Nexmo Community Slack](https://developer.nexmo.com/community/slack) | ||
|
||
## Security Vulnerabilities | ||
## Further Reading | ||
|
||
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed. | ||
* Check out the Developer Documentation at <https://developer.nexmo.com> | ||
|
||
## License | ||
|
||
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). |