Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TECH] Proposition de modifications pour le setup de developement #63

Merged
merged 3 commits into from
Dec 13, 2024

Conversation

Steph0
Copy link
Contributor

@Steph0 Steph0 commented Dec 11, 2024

🎄 Problème

En mettant en place mon environnement de dev pour le projet, j'ai du parcourir pas mal d'elements pour reussir a faire un premier appel reussi.

🎁 Proposition

Ajustements pour permettre une entree dans l'outil + facile

  • Renforcement de la documentation OpenAPI
    • Passage sur une spec + recente (OpenAPI 3)
    • Migration de la documentation actuelle
    • Renforcement de la documentation pour que on puisse essayer l'API sans lire le code
  • Correctif pour pouvoir lancer l'API en mode watch
    • ne pas dependre d'une install de dependance en global
    • avoir un watch qui detecte les changements et reload
  • Ajout d'une configuration pour vscode comme dans le projet Pix

🧦 Remarques

Le template des RA est pas encore parfait, voici l'url pour tester : https://pix-api-data-integration-pr63.osc-fr1.scalingo.io/documentation

🎅 Pour tester

  • Installer le projet
    • docker compose up -d
    • npm ci
    • npm run db:empty
    • npm run db:reset
    • copier le sample.env en .env
  • Lancer l'API en watch
    • npm run start:watch : il ne doit plus y avoir d'erreur
    • verifier que l'API est bien lance : [http://localhost:3000/documentation]
    • modifier un fichier, par exemple le titre dans le fichier lib/infrastructure/plugins/swagger.ts
    • recharger la page de documentation et constater que le changement a ete automatiquement pris en compte
  • Verifier la nouvelle spec OpenApi
    • Page [https://pix-api-data-integration-pr63.osc-fr1.scalingo.io/documentation]

    • Aller dans /token, cliquer sur Try it out puis executer
      image

    • Copier le token donne
      image

    • Aller sur /query et ajouter le token avec Bearer <MON_TOKEN>
      image

    • Executer l'API /query, et verifier que l'on obtient bien un 200

image

@pix-bot-github
Copy link

Une fois l'application déployée, elle sera accessible à cette adresse https://api-data-pr63.review.pix.fr
Les variables d'environnement seront accessibles sur scalingo https://dashboard.scalingo.com/apps/osc-fr1/pix-api-data-integration-pr63/environment

@Steph0 Steph0 force-pushed the api-data-dev-setup branch from 782b631 to 836077b Compare December 11, 2024 17:34
package.json Outdated Show resolved Hide resolved
lib/common/db/seeds/seed.js Outdated Show resolved Hide resolved
lib/common/db/seeds/seed.js Outdated Show resolved Hide resolved
@Steph0 Steph0 force-pushed the api-data-dev-setup branch from 836077b to e34c788 Compare December 12, 2024 09:26
@Steph0 Steph0 force-pushed the api-data-dev-setup branch from e34c788 to 3f3b608 Compare December 12, 2024 11:01
Copy link
Member

@AndreiaPena AndreiaPena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pas très JetBrains friendly mais je met ma coche...

@pix-service-auto-merge pix-service-auto-merge merged commit 6d4b57c into dev Dec 13, 2024
11 checks passed
pix-service-auto-merge pushed a commit that referenced this pull request Dec 16, 2024
# [0.11.0](v0.10.2...v0.11.0) (2024-12-16)

### 🚀 Amélioration

- [#59](#59) Ajout de la possibilité * comme paramètre (PIX-15594)

### 🏗️ Tech

- [#63](#63) Proposition de modifications pour le setup de developement
@pix-service-auto-merge
Copy link
Contributor

🎉 This PR is included in version 0.11.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants