Skip to content

nadir9292/JobInQuiz

Repository files navigation

API de l'application JOB'IN QUIZ

Cette documentation vous guide pour installer et utiliser l'API et le front du site Job'in quiz.

Installation

  1. Clonez le projet
    git clone https://github.com/dani03/quizDEV.git
    cd quizDEV
    

1.bis Si vous avez la version docker compose et pas docker-compose Lancer toutes les commandes ci-dessous avec la commande

   make build-start
  1. Installez les dépendances
    docker-compose run --rm composer install
  2. Configurez l'environnement
  • Allez dans le dossier src.

  • Copiez le fichier .env.exemple et renommez-le .env.

  • Ajoutez le bloc suivant dans .env :

    DB_CONNECTION=mysql
    DB_HOST=mysql
    DB_PORT=3306
    DB_DATABASE=quizdevbdd
    DB_USERNAME=homestead
    DB_PASSWORD=secret
  1. Générez la clé de l'application

    docker-compose run --rm artisan key:generate
  2. Installez Passport

    docker-compose run --rm artisan migrate
    docker-compose run --rm artisan passport:install
  3. Supprimez le dossier "mysql" s'il existe à la racine du projet

  4. Lancez les conteneurs

    docker-compose up --build -d nginx
    docker-compose up --build -d nginx nextjs
    docker-compose ps

    Testez l'API à l'endpoint : https://localhost/api/v1/test.

Lancer les migrations

  1. Lancer les migrations

    docker-compose run --rm artisan migrate
  2. Lancer les seeders

    docker-compose run --rm artisan db:seed

Accès à PHPMyAdmin

Rafraîchir la base de données

Pour rafraîchir la base de données après une modification :

    docker-compose run --rm artisan db:seed
    docker-compose run --rm artisan passport:install
    docker-compose run --rm artisan db:seed

Documentation des endpoints de l'API

  • Accédez à la documentation des endpoints : Documentation API avec SCRAMBLE.

Front

cd /front
npm install
npm run dev

Fichier .gitignore

/mysql/*
/front/.next
/front/node_modules
/front/README.md

Générer des questions avec OpenAI

  • Ajoutez une clé OPENAI_API_KEY dans votre fichier .env avec votre clé API OpenAI.
  • Créez une clé OpenAI sur la plateforme OpenAI.

En cas de problème de cache BDD

docker-compose run --rm artisan cache:clear
docker-compose run --rm artisan config:clear

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published