Aller au contenu

Guide de Démarrage Rapide

Ce guide vous montre comment démarrer un nouveau projet et le déployer avec Nekristo en quelques minutes.

Étape 1 : Prérequis

  • Python 3.8+ et pip
  • Docker et Docker Compose
  • GnuPG (GPG)
  • (Optionnel mais recommandé) CLI GitHub (gh) pour l'automatisation des secrets.

Étape 2 : Installation du CLI

À la racine du monorepo, exécutez :

# 1. Créez et activez un environnement virtuel
python -m venv .venv
source .venv/bin/activate

# 2. Installez le CLI en mode éditable
pip install -e .

Étape 3 : Créer une Nouvelle Application via un Template

La manière la plus simple de démarrer est d'utiliser un template. Créons une nouvelle API avec le template fastapi.

nekristo-cli apps new ma-super-api --template fastapi

Cette commande crée une application fonctionnelle dans apps/ma-super-api/ avec un manifeste nekristo.yml déjà configuré.

Étape 4 : Générer la Configuration Docker

# Génère les fichiers Docker pour votre nouvelle application
nekristo-cli apps gen-docker --app-name ma-super-api

Étape 5 : Démarrer l'Environnement Local

  1. Lancer l'infrastructure partagée (Nginx, base de données...). Cela ne doit être fait qu'une seule fois.

    ```bash

    À la racine du projet

    nekristo-cli up ```

  2. Configurer le proxy local. Cette commande configure Nginx pour qu'il reconnaisse votre nouvelle application.

    ```bash

    À la racine du projet

    nekristo-cli platform setup-proxy ```

  3. Lancer votre application.

    bash nekristo-cli apps start ma-super-api

    Cette commande crée automatiquement la base de données si elle est définie dans le manifeste (comme c'est le cas pour le template fastapi) avant de démarrer les conteneurs.

Votre application est maintenant accessible via son domaine local (ex: http://ma-super-api.127.0.0.1.nip.io) ! Si vous modifiez le code source Python, le serveur devrait se recharger automatiquement grâce au hot-reloading configuré dans le template.

Étape 6 : Lancer les Tests

Assurez-vous que tout fonctionne comme prévu en lançant la suite de tests.

nekristo-cli apps test ma-super-api

Étape 7 : Déployer en Production

  1. Générez le workflow de CI/CD :

    ```bash

    À la racine du projet

    nekristo-cli ci gen-workflow ```

  2. Configurez les secrets sur GitHub (voir le guide de configuration du VPS, idéalement via nekristo-cli ci setup-secrets ou platform provision-vps).

  3. Poussez vos changements sur la branche de déploiement.

GitHub Actions prendra le relais pour valider, tester, scanner et déployer votre application.