Skip to content

Commit 67de1e7

Browse files
authored
Revise README for Laravel CI/CD Automation Suite
Updated README to reflect CI/CD pipeline for Laravel application.
1 parent c7679b3 commit 67de1e7

1 file changed

Lines changed: 49 additions & 51 deletions

File tree

README.md

Lines changed: 49 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,67 @@
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>
21

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>
2+
# 🚀 Laravel CI/CD Automation Suite
93

10-
## About Laravel
4+
This repository demonstrates a modern **CI/CD pipeline** built using **GitHub Actions**. It focuses on automating the validation, build, and deployment readiness of a containerized Laravel application, ensuring that only high-quality, tested code reaches production.
115

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:
6+
---
137

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).
8+
## 🏗️ Pipeline Architecture
219

22-
Laravel is accessible, powerful, and provides tools required for large, robust applications.
10+
The pipeline is designed to handle both frontend and backend assets through isolated, optimized build environments:
2311

24-
## Learning Laravel
12+
1. **Continuous Integration (CI)**:
13+
- **Linting & Code Quality**: Automatic checks for PHP and JavaScript styling.
14+
- **Automated Testing**: Runs the PHPUnit suite to ensure business logic integrity.
15+
- **Environmental Isolation**: Uses `.env.ci` to manage pipeline-specific variables.
16+
2. **Continuous Deployment (CD) Readiness**:
17+
- **Multi-Stage Docker Builds**:
18+
- `Dockerfile.php`: Optimized for high-performance PHP-FPM serving.
19+
- `Dockerfile.node`: Handles Vite/Tailwind asset compilation.
20+
- **Artifact Management**: Generates production-ready images ready to be pushed to a registry.
2521

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.
22+
---
2723

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.
24+
## 🛠️ Tech Stack
2925

30-
If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains over 2000 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.
26+
- **Workflow Engine**: [GitHub Actions](https://github.com/features/actions)
27+
- **Application**: Laravel 11.x
28+
- **Containerization**: Docker & Docker Compose
29+
- **Environment**: PHP 8.2+, Node.js 20+
30+
- **Testing**: PHPUnit
3131

32-
## Laravel Sponsors
32+
---
3333

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).
34+
## 📂 Repository Highlights
3535

36-
### Premium Partners
36+
| Component | Responsibility |
37+
| :--- | :--- |
38+
| `.github/workflows/` | Declarative YAML files defining the pipeline stages. |
39+
| `Dockerfile.php` | The PHP-FPM container configuration. |
40+
| `Dockerfile.node` | The Node.js environment for frontend build steps. |
41+
| `docker-compose.yml` | Local orchestration for dev/testing environments. |
42+
| `.env.ci` | Configuration tailored for the GitHub Actions runner. |
3743

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)**
44+
---
5145

52-
## Contributing
46+
## 🚀 Getting Started
5347

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).
48+
### **Running Locally**
49+
1. **Clone the repository**:
50+
```bash
51+
git clone [https://github.com/shashidas95/basic_ci_cd.git](https://github.com/shashidas95/basic_ci_cd.git)
52+
```
53+
2. **Setup Containers**:
54+
```bash
55+
docker-compose up -d
56+
```
5557

56-
## Code of Conduct
58+
### **Triggering the Pipeline**
59+
The pipeline is configured to trigger automatically on:
60+
- Every `push` to the `main` branch.
61+
- Every `pull_request` targeting the `main` branch.
5762

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).
63+
---
5964

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).
67-
68-
## Email sending
69-
- php artisan make:mail NewPostEmail
65+
## 👨‍💻 Author
66+
**Shashi Kanta Das**
67+
*Software Architect | DevOps Engineer | Assistant Director @ BSTI*

0 commit comments

Comments
 (0)