|
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> |
| 1 | +# Professional Laravel REST API Boilerplate |
2 | 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> |
| 3 | +[](https://laravel.com) |
| 4 | +[](https://php.net) |
| 5 | +[](https://github.com/tymon/jwt-auth) |
| 6 | +[](https://scramble.dedoc.co/) |
9 | 7 |
|
10 | | -## About Laravel |
| 8 | +A modern, production-ready REST API boilerplate built with **Laravel 12**. This repository is designed to kickstart robust backend development with best practices, automated documentation, and secure authentication out of the box. |
11 | 9 |
|
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: |
| 10 | +## π Key Features |
13 | 11 |
|
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). |
| 12 | +- **Standardized RESTful Architecture**: Clean and scalable structure for modern API development. |
| 13 | +- **JWT Authentication**: Secure user authentication using `tymon/jwt-auth`. |
| 14 | +- **Auto-generated Documentation**: Real-time API documentation via **Scramble** (no manual PHPDoc required). |
| 15 | +- **Modern Testing Suite**: Pre-configured with **Pest PHP** for elegant and efficient testing. |
| 16 | +- **Developer Friendly**: Includes pre-defined scripts for setup, testing, and development. |
| 17 | +- **Docker Ready**: Includes `Dockerfile` and `.dockerignore` for containerized environments. |
21 | 18 |
|
22 | | -Laravel is accessible, powerful, and provides tools required for large, robust applications. |
| 19 | +## π οΈ Tech Stack |
23 | 20 |
|
24 | | -## Learning Laravel |
| 21 | +- **Framework**: Laravel 12.x |
| 22 | +- **Language**: PHP 8.2+ |
| 23 | +- **Security**: JSON Web Token (JWT) |
| 24 | +- **Documentation**: Scramble (OpenAPI/Swagger) |
| 25 | +- **Testing**: Pest PHP |
| 26 | +- **Utilities**: Laravel Tinker, Pint (Style Fixer), Sail (Docker) |
25 | 27 |
|
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. You can also check out [Laravel Learn](https://laravel.com/learn), where you will be guided through building a modern Laravel application. |
| 28 | +## βοΈ Quick Start |
27 | 29 |
|
28 | | -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. |
| 30 | +1. **Clone the repository** |
| 31 | + ```bash |
| 32 | + git clone https://github.com/arsyadkamaluddin/laravel-rest-api-boiler-plate.git |
| 33 | + cd laravel-rest-api-boiler-plate |
| 34 | + ``` |
29 | 35 |
|
30 | | -## Laravel Sponsors |
| 36 | +2. **Automated Setup** |
| 37 | + Run the pre-defined setup script to install dependencies, generate keys, and run migrations: |
| 38 | + ```bash |
| 39 | + composer run setup |
| 40 | + ``` |
31 | 41 |
|
32 | | -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). |
| 42 | +3. **Environment Setup** |
| 43 | + Ensure your `.env` file has the correct database credentials. |
33 | 44 |
|
34 | | -### Premium Partners |
| 45 | +4. **Run Development Server** |
| 46 | + ```bash |
| 47 | + php artisan serve |
| 48 | + ``` |
35 | 49 |
|
36 | | -- **[Vehikl](https://vehikl.com)** |
37 | | -- **[Tighten Co.](https://tighten.co)** |
38 | | -- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)** |
39 | | -- **[64 Robots](https://64robots.com)** |
40 | | -- **[Curotec](https://www.curotec.com/services/technologies/laravel)** |
41 | | -- **[DevSquad](https://devsquad.com/hire-laravel-developers)** |
42 | | -- **[Redberry](https://redberry.international/laravel-development)** |
43 | | -- **[Active Logic](https://activelogic.com)** |
| 50 | +## π API Documentation |
44 | 51 |
|
45 | | -## Contributing |
| 52 | +Once the server is running, you can access the automatically generated API documentation at: |
| 53 | +`http://localhost:8000/docs/api` |
46 | 54 |
|
47 | | -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 | +## π¨βπ» Developed By |
48 | 56 |
|
49 | | -## Code of Conduct |
| 57 | +**Kamaluddin Arsyad Fadllillah** |
| 58 | +*Fullstack Web Developer | UGM Software Engineering* |
50 | 59 |
|
51 | | -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). |
| 60 | +- π§ [arsyadkamaluddin@gmail.com](mailto:arsyadkamaluddin@gmail.com) |
| 61 | +- π [LinkedIn](https://linkedin.com/in/arsyadkamaluddin) |
| 62 | +- π [Portfolio](https://disyfa.space) |
| 63 | +- π [+62 896-3605-5420](https://wa.me/6289636055420) |
52 | 64 |
|
53 | | -## Security Vulnerabilities |
54 | | - |
55 | | -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. |
56 | | - |
57 | | -## License |
58 | | - |
59 | | -The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). |
| 65 | +--- |
0 commit comments