Skip to content

Commit

Permalink
Merge pull request #89 from gsteel/fix-readme-lint
Browse files Browse the repository at this point in the history
Readme Linting Fixes
  • Loading branch information
gsteel authored Oct 16, 2024
2 parents f5a0053 + b3d47f4 commit 58a8c56
Showing 1 changed file with 23 additions and 32 deletions.
55 changes: 23 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# laminas-mvc-skeleton

> ## 🇷🇺 Русским гражданам
>
>
> Мы, участники Laminas, родились и живем в разных странах. У многих из нас есть друзья, родственники и коллеги как в России, так и в Украине. Некоторые из нас родились в России. Некоторые из нас живут в России. У некоторых бабушки и дедушки сражались с фашистами во Второй мировой войне. Здесь никто не поддерживает фашизм.
>
>
> У одного из нас есть украинская родственница, которая спаслась из дома вместе с сыном. Поезд задержался из-за бомбежки на дороге впереди. У нас есть друзья, которые прячутся в бомбоубежищах. Мы с тревогой ждем весточки от них после воздушных налетов, которые беспорядочно наносят удары и попадают по больницам, школам, детским садам и домам. Мы не берем это из каких-либо СМИ. Мы наблюдаем это напрямую.
>
>
> Вы доверяете нам достаточно, чтоб использовать наши программы, и мы просим вас довериться нам вновь. Мы нуждаемся в помощи. Выходите и протестуйте против этой бесполезной войны. Остановите кровопролитие. Скажите "Нет войне!"
>
>
> ## 🇺🇸 To Citizens of Russia
>
>
> We at Laminas come from all over the world. Many of us have friends, family and colleagues in both Russia and Ukraine. Some of us were born in Russia. Some of us currently live in Russia. Some have grandparents who fought Nazis in World War II. Nobody here supports fascism.
>
>
> One team member has a Ukrainian relative who fled her home with her son. The train was delayed due to bombing on the road ahead. We have friends who are hiding in bomb shelters. We anxiously follow up on them after the air raids, which indiscriminately fire at hospitals, schools, kindergartens and houses. We're not taking this from any media. These are our actual experiences.
>
>
> You trust us enough to use our software. We ask that you trust us to say the truth on this. We need your help. Go out and protest this unnecessary war. Stop the bloodshed. Say "stop the war!"
## Introduction
Expand Down Expand Up @@ -43,9 +43,8 @@ $ php -S 0.0.0.0:8080 -t public
$ composer serve
```

This will start the cli-server on port 8080, and bind it to all network
interfaces. You can then visit the site at http://localhost:8080/
- which will bring up Laminas MVC Skeleton welcome page.
This will start the cli-server on port 8080, and bind it to all network interfaces.
You can then visit the site at http://localhost:8080/ which will bring up Laminas MVC Skeleton welcome page.

**Note:** The built-in CLI server is *for development only*.

Expand All @@ -66,7 +65,7 @@ configuration in `config/autoload/development.local.php.dist`. Enabling
development mode will copy these files to versions removing the `.dist` suffix,
while disabling development mode will remove those copies.

Development mode is automatically enabled as part of the skeleton installation process.
Development mode is automatically enabled as part of the skeleton installation process.
After making changes to one of the above-mentioned `.dist` configuration files you will
either need to disable then enable development mode for the changes to take effect,
or manually make matching updates to the `.dist`-less copies of those files.
Expand Down Expand Up @@ -97,7 +96,7 @@ control. (If you want to make the modifications permanent, edit the
## Running Psalm Static Analysis

To run the supplied skeleton static analysis, you need to do one of the following:
It is recommended to install the test components from laminas (laminas/laminas-test),
It is recommended to install the test components from laminas (laminas/laminas-test),
as this is used in the tests supplied.

```bash
Expand All @@ -112,10 +111,8 @@ $ composer static-analysis

## Using docker-compose

This skeleton provides a `docker-compose.yml` for use with
[docker-compose](https://docs.docker.com/compose/); it
uses the provided `Dockerfile` to build a docker image
for the `laminas` container created with `docker-compose`.
This skeleton provides a `docker-compose.yml` for use with [docker-compose](https://docs.docker.com/compose/);
it uses the provided `Dockerfile` to build a docker image for the `laminas` container created with `docker-compose`.

Build and start the image and container using:

Expand All @@ -125,19 +122,16 @@ $ docker-compose up -d --build

At this point, you can visit http://localhost:8080 to see the site running.

You can also run commands such as `composer` in the container. The container
environment is named "laminas" so you will pass that value to
`docker-compose run`:
You can also run commands such as `composer` in the container.
The container environment is named "laminas" so you will pass that value to `docker-compose run`:

```bash
$ docker-compose run laminas composer install
```

Some composer packages optionally use additional PHP extensions.
The Dockerfile contains several commented-out commands
which enable some of the more popular php extensions.
For example, to install `pdo-pgsql` support for `laminas/laminas-db`
uncomment the lines:
Some composer packages optionally use additional PHP extensions.
The Dockerfile contains several commented-out commands which enable some of the more popular php extensions.
For example, to install `pdo-pgsql` support for `laminas/laminas-db` uncomment the lines:

```sh
# RUN apt-get install --yes libpq-dev \
Expand All @@ -153,8 +147,8 @@ then re-run the `docker-compose up -d --build` line as above.

### Apache setup

To setup apache, setup a virtual host to point to the public/ directory of the
project and you should be ready to go! It should look something like below:
To setup apache, setup a virtual host to point to the public/ directory of the project and you should be ready to go!
It should look something like below:

```apache
<VirtualHost *:80>
Expand All @@ -174,9 +168,7 @@ project and you should be ready to go! It should look something like below:

### Nginx setup

To setup nginx, open your `/path/to/nginx/nginx.conf` and add an
[include directive](http://nginx.org/en/docs/ngx_core_module.html#include) below
into `http` block if it does not already exist:
To setup nginx, open your `/path/to/nginx/nginx.conf` and add an [include directive](http://nginx.org/en/docs/ngx_core_module.html#include) below into `http` block if it does not already exist:

```nginx
http {
Expand All @@ -185,9 +177,8 @@ http {
}
```


Create a virtual host configuration file for your project under `/path/to/nginx/sites-enabled/laminasapp.localhost.conf`
it should look something like below:
Create a virtual host configuration file for your project under `/path/to/nginx/sites-enabled/laminasapp.localhost.conf`.
It should look something like below:

```nginx
server {
Expand Down

0 comments on commit 58a8c56

Please sign in to comment.