P7 OC DA/PHP - Symfony

Create a web service exposing an API

Getting Started

These instructions will get you a copy of the project up and running on your local machine if you want to test it or develop something on it.

Prerequisites

To make the project run you will need to install those things :

• Laragon
• PHP 7.4.19
• Apache 2.4.35
• MySQL 5.7.24
• Composer
• Symfony

Installing

Follow those steps to make the project run on your machine

Clone the project :

git clone https://github.com/mathiiii-dev/BileMo.git

Install composer dependencies :

composer install

Database & DataFixtures

First edit .env (or create a .env.local to override it) with your database credentials :

DATABASE_URL="mysql://root:@127.0.0.1:3306/bilemo?serverVersion=5.7"

Create the database :

php bin/console doctrine:database:create

Update schema :

php bin/console doctrine:schema:update --force

Load some data into the database :

php bin/console doctrine:fixtures:load

JWT Config

Edit .env (or .env.local) :

JWT_SECRET_KEY=%kernel.project_dir%/config/jwt/private.pem
JWT_PUBLIC_KEY=%kernel.project_dir%/config/jwt/public.pem
JWT_PASSPHRASE=

Generate SSL key :

php bin/console lexik:jwt:generate-keypair

or like this :

openssl genrsa -out config/jwt/private.pem 4096
openssl rsa -pubout -in config/jwt/private.pem -out config/jwt/public.pem

Test account

You can test the API with those credentials :

Pseudo : Mathias
Password : password

Launch project

Using Symfony CLI :

symfony serve

or :

php bin/console server:start

Project Test

If you want to test this project you have two options :

You can test this via Postman by downloading this collection : Collection postman bilemo

Or you can test it via an frontend app I've made with Nuxt.JS : https://bilemo-frontend.herokuapp.com/

Frontend app Github Repository : https://github.com/mathiiii-dev/bilemo-frontend

API Documentation

You can find the documention here : https://127.0.0.1:8000/swagger/ or here : https://api-bilemo.herokuapp.com/swagger/index.html#/

Built With

• Symfony - Framework PHP
• LexikJWTAuthenticationBundle - JWT Bundle
• JWTRefreshTokenBundle - Refresh JWT Bundle
• BazingaHateoasBundle - Richardson Model
• NelmioCorsBundle - CORS Bundle
• Swagger-PHP - API Documentation

Versioning

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

Authors

• Mathias Micheli - Student - Github