README.md

PROJECT NAME

Project description

Table of Contents

• Getting Started
• Prerequisites
• Installing
  • Configuration
  • Docker compose usage
  • Dependencies install
  • Data import
  • Source files
• Environment
  • Code quality
  • PHP commands usage
• Running the tests
  • Unit testing
  • End to end tests testing
• Delivery
• Deployment
  • Test environment
  • Production environment
• Built With
• Versioning

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. You can plug any of this tools to your favourite IDE.

Prerequisites

You need to have the following softwares installed on your local machine:

• Docker for windows
• Git
• Windows PowerShell

Installing

Clone project using ssh (you will need to set a SSH key in your Gitlab profile)

git clone git@github.com

Configuration

• Each ./Dockerfile contains a basic configuration for developing with Symfony 4 framework and deploying in a production environment.
• The file .env allows to set the name of the Docker project's stack as well as basic PHP image version for Docker
• The file .env.dev.local must be created (and git ignored) to fill in empty parameters from the /.env file

Docker compose usage

• Run / init: docker-compose up
• Stop: docker-compose stop
• Destroy: docker-compose down
• Cleanup: docker-compose rm -vsf
• Reset: docker system prune -af --volumes

Dependencies install

When starting the backend container, Composer will download and install dependencies in ./vendor directory

Data import

We use name and link to the SGBDR documentation for this project.

Explain how to import data when you start working on this project

Source files

Explain where your source code is located

Environment

Code quality

We use code quality tools which you can plug in your favourite IDE:

List which code quality tools are used and mandatory in this project For each tool: name, link to documentation and path to the associated config file

PHP commands usage

Use this pattern

docker-compose exec backend php <entrypoint> <command> <args>

Running the tests

Unit testing

Launch tests with associated config file in `` Path to the phpunit.xml.dist file

docker-compose exec backend php bin/phpunit --configuration phpunit.xml.dist tests/

End to end tests testing

Launch tests with associated config file in `` path to the behat.yml.dist file

docker-compose exec backend vendor/behat/behat/bin/behat --config behat.yml.dist features/

Delivery

Explain how do you deliver the project to the client

Deployment

Test environment

Explain how do you deploy in test environment

Production environment

Explain how do you deploy in production environment

Built With

List which code and test frameworks and libraries are used in this project For each one: name and link to documentation

• Symfony & API Platform - PHP Framework
• MySQL - SGBDR
• PHP Unit & Prophecy - Unit tests framework
• Behat - Functional tests framework
• Composer - Dependency management
• Docker - Virtualization and container management

Versioning

We use Git and Gitflow with conventional commits for versioning.