sebzz07 / bileMoAPI

An API of BileMo

bileMoAPI - Projet 7

An API of BileMo

Codacy Badge :

Installation :

This project has been developed under php 8.1 and symfony 6.1.

Start this project in localhost mode, run some command lines:

1. Clone the GitHub repo:

git clone https://github.com/sebzz07/bileMoAPI.git

2. Go to the root of the project.

3. Create the folder config/jwt/

4. Generate your private/public key with this two Openssl commands line :

php bin/console lexik:jwt:generate-keypair
setfacl -R -m u:www-data:rX -m u:"$(whoami)":rwX config/jwt
setfacl -dR -m u:www-data:rX -m u:"$(whoami)":rwX config/jwt

5. Create and fill out your own .env.*

6. At the root of the project, install dependencies with composer:

composer install

7. Create database and some fixtures via doctrine :

with the script :

composer initialize

or :

"symfony console doctrine:database:create",
"symfony console doctrine:schema:update --force",
"symfony console doctrine:fixtures:load -n"

8. run local server :

symfony server:start -d

Now the project is normally deploy correctly

Information to test the project :

Your can check the documentation to understand the api and to test it :

https://localhost:8000/api/doc

You can use one of the nine accounts created with the fixtures or just follow token's route : https://localhost:8000/api/login_check

[e-mail]//password
...
[e-mail]//password

You will find the token of your connection, copy it and click on the button "Authorize" at the top right of the page.

In the field "Value" type : bearer YourToken.

Now your can use the API.

Thank you