|
1 |
| -## laravel API |
2 |
| - |
3 |
| -## Lib |
4 |
| -- Laravel 9.x |
5 |
| -- Twillo (SMS) |
6 |
| -- Firebase (Push Notifications) |
7 |
| - |
8 |
| -# Installation |
9 |
| -1. Run git clone https://github.com/dexbytesinfotech/laravel-api.git laravel-api |
10 |
| -2. Create a MySQL database for the project - `laravel-example` |
11 |
| -3. From the projects root run `cp .env.example .env` |
12 |
| -4. Configure your `.env` file |
13 |
| -5. From the projects root folder run `composer update` |
14 |
| -6. From the projects root folder run `php artisan key:generate` |
15 |
| -7. From the projects root folder run `php artisan migrate:fresh --seed` |
16 |
| -8. From the projects root folder run `composer dump-autoload` |
17 |
| -9. From the projects root folder run `php artisan storage:link` |
18 |
| -10. From the projects root folder run `php artisan l5-swagger:generate` (https://github.com/DarkaOnLine/L5-Swagger) |
19 |
| -11. From the projects root folder run (local) `php artisan schedule:work` for server use supervisor |
20 |
| -12. From the projects root folder run (local) `php artisan schedule:work` for server use scheduling * * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1 |
21 |
| - |
22 |
| - |
23 |
| -# Admin Panel |
24 |
| -1. Project https://github.com/dexbytesinfotech/livewire should be after installed API code in your server or machine |
25 |
| - |
26 |
| -### Storage folder Ownership and Permission |
27 |
| -1. Check the permissions on the storage directory: `chmod -R 775 storage` |
28 |
| -1. Check the ownership of the storage directory: : `chown -R www-data:www-data storage` |
29 |
| - |
30 |
| -### Seeds |
31 |
| -##### Seeded Roles |
32 |
| - * Unverified |
33 |
| - * User |
34 |
| - * Admin |
35 |
| - * Manager |
36 |
| - |
37 |
| -##### Seeded Users |
38 |
| - |
39 |
| -|Email|Password|Access| |
40 |
| -|:------------|:------------|:------------| |
41 |
| -|admin@admin.com|admin123|Admin Access| |
42 |
| - |
43 |
| -### API keys |
44 |
| - |
45 |
| -- [Google Maps API v3 Key](https://developers.google.com/maps/documentation/javascript/get-api-key#get-an-api-key) |
46 |
| - |
47 |
| -- [Firebase Server Key] (https://firebase.google.com/) |
48 |
| - |
49 |
| -- [Twilio SMS API Key](https://www.twilio.com/blog/create-sms-portal-laravel-php-twilio) |
50 |
| - |
51 |
| -- [Unifonic SMS API Key](https://docs.unifonic.com/docs/getting-sms-application-1) |
52 |
| - |
53 |
| -## Remove public from url |
54 |
| -```bash |
55 |
| -<IfModule mod_rewrite.c> |
56 |
| - RewriteEngine On |
57 |
| - RewriteRule ^(.*)$ public/$1 [L] |
58 |
| -</IfModule> |
59 |
| -``` |
60 |
| -## Cron Jobs |
61 |
| -1. Send scheduled push notification `Push\NotificationController@sendScheduledPushNotification` |
62 |
| - |
63 |
| - |
| 1 | +<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p> |
| 2 | + |
| 3 | +<p align="center"> |
| 4 | +<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a> |
| 5 | +<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a> |
| 6 | +<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a> |
| 7 | +<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a> |
| 8 | +</p> |
| 9 | + |
| 10 | +## About Laravel |
| 11 | + |
| 12 | +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: |
| 13 | + |
| 14 | +- [Simple, fast routing engine](https://laravel.com/docs/routing). |
| 15 | +- [Powerful dependency injection container](https://laravel.com/docs/container). |
| 16 | +- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage. |
| 17 | +- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent). |
| 18 | +- Database agnostic [schema migrations](https://laravel.com/docs/migrations). |
| 19 | +- [Robust background job processing](https://laravel.com/docs/queues). |
| 20 | +- [Real-time event broadcasting](https://laravel.com/docs/broadcasting). |
| 21 | + |
| 22 | +Laravel is accessible, powerful, and provides tools required for large, robust applications. |
| 23 | + |
| 24 | +## Learning Laravel |
| 25 | + |
| 26 | +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. |
| 27 | + |
| 28 | +You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch. |
| 29 | + |
| 30 | +If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of 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. |
| 31 | + |
| 32 | +## Laravel Sponsors |
| 33 | + |
| 34 | +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 Partners program](https://partners.laravel.com). |
| 35 | + |
| 36 | +### Premium Partners |
| 37 | + |
| 38 | +- **[Vehikl](https://vehikl.com/)** |
| 39 | +- **[Tighten Co.](https://tighten.co)** |
| 40 | +- **[WebReinvent](https://webreinvent.com/)** |
| 41 | +- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)** |
| 42 | +- **[64 Robots](https://64robots.com)** |
| 43 | +- **[Curotec](https://www.curotec.com/services/technologies/laravel/)** |
| 44 | +- **[Cyber-Duck](https://cyber-duck.co.uk)** |
| 45 | +- **[DevSquad](https://devsquad.com/hire-laravel-developers)** |
| 46 | +- **[Jump24](https://jump24.co.uk)** |
| 47 | +- **[Redberry](https://redberry.international/laravel/)** |
| 48 | +- **[Active Logic](https://activelogic.com)** |
| 49 | +- **[byte5](https://byte5.de)** |
| 50 | +- **[OP.GG](https://op.gg)** |
| 51 | + |
| 52 | +## Contributing |
| 53 | + |
| 54 | +Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions). |
| 55 | + |
| 56 | +## Code of Conduct |
| 57 | + |
| 58 | +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). |
| 59 | + |
| 60 | +## Security Vulnerabilities |
| 61 | + |
| 62 | +If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed. |
| 63 | + |
| 64 | +## License |
| 65 | + |
| 66 | +The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). |
0 commit comments