Star wars api bind planet is an API done with Symfony framework. It allows you to connect to SWAP API to illustrate how to use tests.

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.

• A computer with Linux or MacOs

For Windows OS it is more complicated to install the application

• Git

  • install on ubuntu dist:

  sudo apt-get install git

• Docker

  • install on ubuntu dist:

  curl -ssL https://get.docker.com | sh 

• Docker Compose

  • to install docker compose on ubuntu

  sudo curl -L "https://github.com/docker/compose/releases/download/1.25.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

  sudo chmod +x /usr/local/bin/docker-compose

• Make

  • to install in Linux dist

  sudo apt-get install build-essential

• Php 7.1 or heigher

  • see the documentation

To install the project, you need to clone the repository on your machine:

git clone https://github.com/faycalBordjah/dm-ci20-4

• To the application using PHP's built-in web server is as easy as executing this command:

make start

-You can run also the application with docker by move to your project directory and just run the following command:

docker-compse up

Now you access to the server on your localhost

you will get this response:

{
    status: "ok"
}

make test

php unit tests
to launch: make test_unit

The functionnal test of application
run: make test_functional

integration test of the application run: make test_integration

The coding style of the project is checked by 2 tools:

• php-cs-fixer that checks our code relating to several rules defined by php community
• Hadolint that checks used Dockerfile on the project

Add additional notes about how to deploy this on a live system

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

For the versions available, see the tags on this repository.

• Vincent Monjaret - Initial work - vmonjaret

See also the list of contributors who participated in this project.

This project is licensed under the MIT License - see the LICENSE.md file for details

• Hat tip to anyone whose code was used
• Inspiration
• etc