CLI : Les différentes commandes

[damienld22]

Objectif

Spécifier les différentes commandes que nous pouvons utiliser avec la CLI (new, push, run ...). Le but n'est pas de décrire en détails chaque commande, ni de tout développer ce qui aura été spécifié ci-dessous. (priorisation)

L'objectif est d'avoir une vue d'ensemble sur les différentes commandes et de se mettre d'accord sur le fonctionnel que nous voulons apporter avec la CLI

Précisions

L'utilisation de la CLI est bien-sûr optionnelle, en revanche elle est très utile pour l'expérience de développement. Dans chaque cas d'usage il sera bien-sûr possible de se passer de la CLI.

Pour certains cas d'usage, des éléments techniques seront présentés, seulement dans le but de bien comprendre le raisonnement apporté.

Commandes

zeta init

Initialisation d'un projet Celtia dans le cas où le développeur a déjà déjà un projet existant ou non.

• Si le développeur spécifie son compte ZetaPush, une application est créée. Dans le cas contraire, un compte temporaire est créé avec aussi une application de créée automatiquement.

• Sauvegarde des différentes informations du compte développeur dans un fichier à la racine du projet (.zetarc ?)

• Installation des dépendances NPM nécessaires à l'application.

Lors de la création de l'application, une sandbox est créée. Suite à ça, la CLI se charge de déployer un service de Queue pour permettre le déploiement de services en temps réel.

zeta new

Création d'une application d'exemple pour le développeur

• Cette commande commence par faire un zeta init

• Génération d'un code d'exemple

À suivre l'évolution de la commande npm init : En effet, cette commande pourra par le futur créer un code d'exemple en lançant seulement npm init @zetapush par exemple.

zeta push

Déploiement du code du développeur

• Déploiement du code back sur la plateforme ZetaPush

• Déploiement du code front sur la plateforme ZetaPush

zeta run

Lancement en local du code back

• Déploiement de tous les services nécessaires sur la plateforme ZetaPush

• Lancement d'un Node en local avec le code back

zeta nuke

Suppression d'une application

• Suppression de l'ensemble de de l'application

À discuter

Un point que je voudrais soulever est la récupération d'une application déjà créée par un développeur de mon équipe. Par exemple une application est déjà en cours de développement et je viens d'arriver sur le projet. Pour récupérer le projet en son état actuel, comment est-ce que ça se passe ?

Voici ma proposition : La nouveau développeur récupère le code via git par exemple. Suite à ça, il peut dans son application lancer zeta init. À ce moment là le développeur est prêt à travailler.

Une issue sera créée pour chaque commande

[raphael22]

+1 pour le zeta init dans le cas d'un projet existant.

[ghoullier]

Séquence des appels

From scratch

npm init @zetapush
zeta init # Commande optionnelle, si l'init n'est pas présent, il est fait automatiquement par le commande zeta run
zeta run

npm init @zetapush
zeta init # Commande optionnelle, si l'init n'est pas présent, il est fait automatiquement par le commande zeta push
zeta push

From existing

zeta init # Commande optionnelle, si l'init n'est pas présent, il est fait automatiquement par le commande zeta run
zeta run

zeta init # Commande optionnelle, si l'init n'est pas présent, il est fait automatiquement par le commande zeta push
zeta push

[damienld22]

Nouvelle version prenant en compte les différentes remarques

Commandes

zeta init #50

Initialisation d'un projet Celtia dans le cas où le développeur a déjà déjà un projet existant ou non.

• Si le développeur spécifie son compte ZetaPush, une application est créée. Dans le cas contraire, un compte temporaire est créé avec aussi une application de créée automatiquement.

• Sauvegarde des différentes informations du compte développeur dans un fichier à la racine du projet (.zetarc ?)

• Installation des dépendances NPM nécessaires à l'application.

Lors de la création de l'application, une sandbox est créée. Suite à ça, la CLI se charge de déployer un service de Queue pour permettre le déploiement de services en temps réel.

zeta new #51

Création d'une application d'exemple pour le développeur

• Cette commande commence par faire un zeta init

• Génération d'un code d'exemple

À suivre l'évolution de la commande npm init : En effet, cette commande pourra par le futur créer un code d'exemple en lançant seulement npm init @zetapush par exemple.

zeta push #52

Déploiement du code du développeur

• Lancement de la commande zeta init si nécessaire

• Déploiement du code back sur la plateforme ZetaPush

• Déploiement du code front sur la plateforme ZetaPush

zeta run #53

Lancement en local du code back

• Lancement de la commande zeta init si nécessaire

• Déploiement de tous les services nécessaires sur la plateforme ZetaPush

• Lancement d'un Node en local avec le code back

[damienld22]

Voici l'évolution de chaque commande de la CLI :

zeta init → register

Rend zetapush utilisable dans mon projet Sauvegarde quelquepart les informations de connection à ZetaPush

zeta new → npm init @zetapush

Créé l’ensemble de l’arboresence pour presenter une application simple zetapush front+worker

zeta push

Déploie le code du développeur sur la plateforme zetapush Fait un register si besoin

zeta push sans paramètre ET SANS fichier de conf déploiement les valeurs de convention

zeta push sans paramètre ET AVEC fichier de conf déploiement tout ce qui est configuré dans le fichier package.json/.zetarc

zeta push avec paramètre ne déploie que ce qui est indiqué via les paramètres

zeta run → zeta run worker

Fait un register si besoin Lance en local le worker sur le poste du développeur