rankup/application

RankUp 应用和域名层

0.1.8 2023-08-19 01:26 UTC

This package is auto-updated.

Last update: 2024-09-19 11:29:25 UTC


README

描述项目内容的段落

通过下载 git 仓库来安装项目...

git clone git@gitlab.com:parchex/rankup/application

先决条件 📋

安装软件所需的物品以及如何安装它们

PHP

需要安装 "PHP cli",无论是在本地还是通过 docker 虚拟化。

为了执行,我们需要 PHP 7.3 或更高版本的命令行,可以是本地安装或 Docker 镜像。

从项目可以生成一个包含所有执行所需内容的 Docker 镜像。在这种情况下,你必须 安装 Docker

Make

为了简化开发任务,已定义了一些通过 make 命令执行的任务,请检查您的系统是否支持此命令,并且您可以从项目目录运行它...

# Muestra las tareas del proyecto
make help

安装 🔧

执行初始化项目,同时本地有 PHP...

make install-dev-env

这样,我们就部署了项目,并包含了其执行所需的依赖和工具...

  • bin 目录中必需的开发和测试工具...
    • composer
    • 测试工具(phpunitbehat,...)
  • 已安装的依赖项(composer
  • 环境配置(文件 .env

如果我们想在 Docker 虚拟环境中工作,并能够使用特定的 Docker 镜像执行应用程序...

make install-docker-env

...这样我们就可以从本地安装获得所有这些内容,以及所需的 Docker 镜像。

如果我们想删除生成的安装,可以执行 make uninstall

工具

除了 make 命令外,还有一个名为 aliases.sh 的文件,其中包含一系列用于执行项目内安装的工具的命令...

# Para instalar los comandos...
. aliases.sh
  • php-cli:我们可以使用项目的 PHP 版本执行任何 PHP 脚本。
php-cli public/index.php
php-cli tests/FileTests.php
  • 开发工具
# Para tests unitarios
phpunit
phpunit-coverage
# Verificar estilo código
phpstan
  • composer:使用应用程序容器的 PHP 版本运行 composer
    . aliases.sh
    

composer update composer show


* También incluye comandos para simplificar la ejecución de Docker con el proyecto.

使用项目镜像执行容器

docker-run


## Ejecutando las pruebas ⚙️

Para comprobar si se pasan los tests...

make test

... y si queremos ver algo más de información ...

make test-verbose make test-coverage

... podemos generar un completo informe de los tests con ...

make tests-report


### Y las pruebas de estilo de codificación ⌨️

Un completo análisis del código utilizando diversas herramientas de revisión y métricas con...

make analyse


## Construido con 🛠️

* [Docker](https://dockerd.com.cn/) - Virtualización
* [Composer](https://getcomposer.org.cn/) - Gestor de dependencias
* [PHPUnit](https://phpunit.de/) - xUnit testing framework
* [Parchex](https://gitlab.com/parchex/basics) - Desarrollo de aplicaciones basadas en DDD/Hexagonal Arch.

## Versionado 📌

Usamos [SemVer](http://semver.org/) para el versionado. 
Para todas las versiones disponibles, mira los [tags en este repositorio](https://gitlab.com/parchex/rankup/application).

## Licencia 📄

Este proyecto está bajo la Licencia (WTFPL) - mira el archivo [LICENSE.md](LICENSE.md) para detalles

---
⌨️ con ❤️ por [Oxkhar](https://oxkhar.com/) 😋