> For the complete documentation index, see [llms.txt](https://dataset-generation-doc.gitbook.io/dataset-generation-doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dataset-generation-doc.gitbook.io/dataset-generation-doc/getting-started/quickstart.md).

# Quickstart

### 📋 Prérequis Techniques 

Afin d'utiliser convenablement la solution, il est recommandé d'être familier avec les structures de données comme le *CSV* et *JSON*. Une connaissance de base du YAML est aussi recommandée. Cependant, elle n'est pas requise.

{% hint style="warning" %}
Pour l'instant il n'est possible de générer des datasets qu'au format JSON et CSV, d'autre formats sont en cours de développement.
{% endhint %}

### Créer votre premier dataset <a href="#crer-votre-premier-dataset" id="crer-votre-premier-dataset"></a>

Choisissez l'approche qui correspond le mieux à votre niveau technique et vos préférences :

### **Option 1 : Interface Graphique** *(Recommandée pour débuter)*

* Interface intuitive sans code
* Création guidée pas-à-pas
* Prévisualisation en temps réel

### **Option 2 : IDE + Configuration YAML** *(Pour utilisateurs avancés)*

* Contrôle granulaire via code
* Configurations réutilisables
* Intégration dans vos workflows DevOps

{% hint style="warning" %}
Si vous optez pour l'IDE, consultez au préalable le guide [utilisation du YAML](/dataset-generation-doc/yaml/comment-generer-un-champ-sur-un-dataset.md) pour maîtriser la syntaxe de configuration.
{% endhint %}

### ⚡ Configuration Initiale <a href="#configuration-initiale" id="configuration-initiale"></a>

### <sub>**Étape 1 : Création du Dataset**</sub> <a href="#configuration-initiale" id="configuration-initiale"></a>

1. **Cliquez sur "Nouveau"** dans votre tableau de bord
2. **Personnalisez le nom** : Remplacez "Nouveau Dataset" par un nom descriptif dans le champ en haut à gauche
3. **Définissez la taille** : Saisissez le nombre de lignes souhaité dans "Nombre de lignes"
4. **Sélectionnez le format** : Choisissez entre JSON ou CSV selon votre cas d'usage

{% hint style="success" %}
**💡 Astuce :** Les deux formats permettent une manipulation simple  des données sans compétences techniques avancées.
{% endhint %}

### Gestion des Champs de Données <a href="#gestion-des-champs-de-donnes" id="gestion-des-champs-de-donnes"></a>

1. **Accédez à l'onglet** [**Génération**](https://datasetgenerationfront-dev.up.railway.app/dashboard/dataset)&#x20;

<figure><img src="/files/2Nwfj52QHpy4UhPOlRrC" alt=""><figcaption></figcaption></figure>

#### 2. **Double-cliquez** sur le nom du champ à modifier

{% hint style="danger" %}
&#x20;Les champs de type `array` et `object` ne peuvent pas être édités directement pour préserver l'intégrité de leurs éléments enfants.
{% endhint %}

<figure><img src="/files/eDicO7uxLI0k9fyJPugp" alt=""><figcaption></figcaption></figure>

### **Ajouter un nouveau champ**

1. **Cliquez sur "ADD"** dans l'interface de génération
2. **Sélectionnez le type** de données souhaité
3. **Validez** votre configuration

#### **Pour des champs personnalisés avec Faker**

1. **Sélectionnez** le type "Faker"
2. **Choisissez** "Méthode Faker"
3. **Entrez** :
   * Le nom d'une méthode Faker standard
   * Le nom de votre variable personnalisée
4. **Cliquez** sur "Valider"

{% hint style="info" %}
Une liste déroulante avec toutes les méthodes disponibles et vos variables personnalisées sera bientôt intégrée pour simplifier la sélection.
{% endhint %}

<figure><img src="/files/UTDh89GfmK76pNh1NQXy" alt=""><figcaption></figcaption></figure>

### Créer une variable personnalisé

Rendez vous sur l'onglet [Variable Faker](https://datasetgenerationfront-dev.up.railway.app/dashboard/faker).

<figure><img src="/files/z2W7EpFWu5B54HMPJZW1" alt=""><figcaption></figcaption></figure>

1. **Initiez la création** : Cliquez sur "Nouveau Type" (coin supérieur droit)
2. **Configurez votre variable** :
   * **Nom** : Donnez un nom descriptif à votre variable
   * **Valeurs** : Listez toutes les valeurs possibles sous format tableau
3. **Finalisez** : Cliquez sur "Ajouter un nouveau type Faker"

<figure><img src="/files/XZJ56KEOvFPZxOfEsX0e" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Une fois créer, il suffit juste d'ajouter son nom dans "Méthode faker" (voir [#ajouter-un-champ](#ajouter-un-champ "mention"))
{% endhint %}