Skip to content

Commit 5263235

Browse files
authored
Merge pull request #412 from wayofdev/docs/updates
2 parents 3ae8ca2 + 6f8f7b4 commit 5263235

File tree

2 files changed

+50
-3
lines changed

2 files changed

+50
-3
lines changed

.github/workflows/testing.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ on: # yamllint disable-line rule:truthy
55
branches:
66
- master
77
- develop
8+
push:
9+
branches:
10+
- master
811

912
name: 🧪 Testing (SQLite)
1013

README.md

Lines changed: 47 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
<p align="center">
2525
<strong>Quality</strong><br>
2626
<a href="https://app.codecov.io/gh/wayofdev/laravel-starter-tpl" target="_blank"><img alt="Codecov" src="https://img.shields.io/codecov/c/github/wayofdev/laravel-starter-tpl?style=flat-square&logo=codecov"></a>
27-
<a href="https://dashboard.stryker-mutator.io/reports/github.com/wayofdev/laravel-starter-tpl/develop" target="_blank"><img alt="Mutation testing badge" src="https://img.shields.io/endpoint?style=flat-square&label=mutation%20score&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fwayofdev%2Flaravel-starter-tpl%2Fdevelop"></a>
27+
<a href="https://dashboard.stryker-mutator.io/reports/github.com/wayofdev/laravel-starter-tpl/develop" target="_blank"><img alt="Mutation testing badge" src="https://img.shields.io/endpoint?style=flat-square&label=mutation%20score&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fwayofdev%2Flaravel-starter-tpl%2Fmaster"></a>
2828
<a href=""><img src="https://img.shields.io/badge/phpstan%20level-8%20of%209-brightgreen?style=flat-square" alt="PHP Stan Level 8 of 9"></a>
2929
</p>
3030
<p align="center">
@@ -134,17 +134,59 @@ To use this repository, you need to meet the following requirements:
134134
> [!Note]
135135
> You should configure, set up, and run the [docker-shared-services](https://github.com/wayofdev/docker-shared-services) repository to ensure system-wide TLS and DNS support.
136136
137+
### → Docker Shared Services
138+
139+
Check full instructions in [docker-shared-services](https://github.com/wayofdev/docker-shared-services) repository.
140+
141+
1. **Create shared project directory:**
142+
143+
```bash
144+
mkdir -p ~/projects/infra && cd ~/projects/infra
145+
```
146+
147+
2. **Clone `docker-shared-services` repository:**
148+
149+
```bash
150+
git clone \
151+
git@github.com:wayofdev/docker-shared-services.git \
152+
~/projects/infra/docker-shared-services && \
153+
cd ~/projects/infra/docker-shared-services
154+
```
155+
156+
3. **Create `.env` file:**
157+
158+
```bash
159+
make env
160+
```
161+
162+
4. **Install root certificate** and generate default project certs:
163+
164+
```bash
165+
make cert-install
166+
```
167+
168+
5. **Run shared services:**
169+
170+
```bash
171+
make up
172+
```
173+
174+
### → Laravel Starter Template
175+
137176
1. **Clone** repository:
138177

139178
After forking or creating generating repository from template, you can clone it to your local machine. In this example we will use `laravel-starter-tpl` repository as starting point.
140179

141180
```bash
142-
git clone git@github.com:wayofdev/laravel-starter-tpl.git
181+
git clone \
182+
git@github.com:wayofdev/laravel-starter-tpl.git \
183+
~/projects/laravel-starter-tpl && \
184+
cd ~/projects/laravel-starter-tpl
143185
```
144186

145187
2. **Generate** `.env` file
146188

147-
Generate .env file from .env.example file using Makefile command:
189+
Generate `.env` file from `.env.example` file using `Makefile` command:
148190

149191
```bash
150192
$ make env \
@@ -178,6 +220,8 @@ To use this repository, you need to meet the following requirements:
178220
$ make up
179221
```
180222

223+
4. **Open** your browser and navigate to `https://laravel-starter-tpl.docker` to see Laravel welcome page.
224+
181225
<br>
182226

183227
## 🤖 Deployment to Staging and Production

0 commit comments

Comments
 (0)