Browse Source

add-description-for-readme

pull/4/head
fedy95 5 years ago
parent
commit
a6446ea995
  1. 5
      Makefile
  2. 29
      README.md

5
Makefile

@ -23,8 +23,9 @@ start: install
stop:
$(DOCKER_COMPOSE) down
# Entering into containers
enter-php:
$(DOCKER_COMPOSE) exec php bash
prepare-request:
$(DOCKER_COMPOSE) exec -T php bash -c "composer run prepare-request"
.DEFAULT_GOAL := install
.DEFAULT_GOAL := init

29
README.md

@ -1,2 +1,31 @@
# 5-cli-template
Template repo "pure-skeleton" with symfony 5.2. Includes:
- local devops via docker-compose and make
- codeception support with acceptance/api/unit-testing
- php/yaml linters
- php/composer code style fixers
### Requirements
- [docker 19+](https://docs.docker.com/engine/install/)
- [docker-compose 1.15+](https://docs.docker.com/compose/install/)
- [make 4.3+](https://www.gnu.org/software/make/)
### Install
```shell script
make init
```
### Development
Enter inside docker container
```shell script
make enter-php
```
Run linters/tests and formatting the code
```shell script
make prepare-request
```
See other useful commands in **Makefile** and **composer.json** under *scripts*