Too Long To Read

Too Long To Read est un projet réalisé en binôme dans le cadre de l'UE de développement web en L2 Informatique à CY Cergy Paris Université durant l'année 2022/2023. Le but de ce projet est la validation des compétences acquises durant l'UE, soit la conception et le développement d'un site web en PHP utilisant une ou plusieurs API(s).

Technologies utilisées

Too Long To Read est ainsi un site web permettant la recherche d'informations sur des livres et auteurs. Le site s'appuie sur l'utilisation des APIs de Google Books et Open Library.

Le site web est développé en PHP et utilise le microframework Slim. De petits wrappers ont été développés afin de faciliter l'utilisation des APIs précédemment mentionnées.

Installation

Afin de faciliter le test de l'application, cette dernière a été conteneurisée et les images sont disponibles ici.

La dernière image disponible peut être récupérée via un client docker avec la commande suivante :

docker pull ghcr.io/gzirysz/too-long-to-read:latest

Un conteneur exécutant l'application peut être lancé avec la commande suivante :

docker run --rm -d \
  -p 80:80 \
  -e GOOGLEAPI_TOKEN="your_token" \
  ghcr.io/gzirysz/too-long-to-read:latest

Un conteneur peut également être créé grâce à Docker Compose. Voici un exemple de configuration :

services:
  tltr:
    image: ghcr.io/gzirysz/too-long-to-read:latest
    container_name: too-long-to-read
    ports:
      - "80:80"
    environment:
      GOOGLEAPI_TOKEN: 'your_token'

La commande suivante doit ensuite être exécutée depuis le répertoire contenant le fichier docker-compose.yml afin de démarrer le conteneur.

docker compose up -d

Environnement

Les variables d'environnement présentées ci-dessous sont toutes obligatoires pour un bon fonctionnement de l'application.

Variable	Default	Description
NASA_TOKEN	DEMO_KEY	La clé d'API utilisée pour l'affichage de l'APOD
GOOGLEAPI_TOKEN	non défini	La clé d'API utilisée par Google Books

Auteurs

@Thomas REMY, @Andrea DE ARAUJO