feat(app,manifest): validation + extendable metadatas
All checks were successful
arcad/edge/pipeline/head This commit looks good
All checks were successful
arcad/edge/pipeline/head This commit looks good
This commit is contained in:
36
doc/apps/manifest.md
Normal file
36
doc/apps/manifest.md
Normal file
@ -0,0 +1,36 @@
|
||||
# Le fichier `manifest.yml`
|
||||
|
||||
Le fichier `manifest.yml` à la racine du bundle de votre application contient des informations décrivant celles ci. Vous trouverez ci dessous un exemple commenté.
|
||||
|
||||
```yaml
|
||||
# REQUIS - L'identifiant de votre application. Il doit être globalement unique.
|
||||
# Un identifiant du type nom de domaine inversé est en général conseillé (ex: tld.mycompany.myapp)
|
||||
id: tld.mycompany.myapp
|
||||
|
||||
# REQUIS - Le numéro de version de votre application
|
||||
# Celui ci devrait respecter le format "semver 2" (voir https://semver.org/)
|
||||
version: 0.0.0
|
||||
|
||||
# REQUIS - Le titre de votre application.
|
||||
title: My App
|
||||
|
||||
# OPTIONNEL - Les mots-clés associés à votre applications.
|
||||
tags: ["chat"]
|
||||
|
||||
# OPTIONNEL - La description de votre application.
|
||||
# Vous pouvez utiliser la syntaxe Markdown pour la mettre en forme.
|
||||
description: |>
|
||||
A simple demo application
|
||||
|
||||
# OPTIONNEL - Métadonnées associées à l'application
|
||||
metadata:
|
||||
# OPTIONNEL - Liste des chemins permettant d'accéder à certains URLs identifiées (page d'administration, icône si existante, etc)
|
||||
paths:
|
||||
# Si défini, chemin vers la page d'administration de l'application
|
||||
admin: /admin
|
||||
# Si défini, chemin vers l'icône associée à l'application
|
||||
icon: /my-app-icon.png
|
||||
|
||||
# OPTIONNEL - Role minimum requis pour pouvoir accéder à l'application
|
||||
minimumRole: visitor
|
||||
```
|
@ -22,23 +22,7 @@ my-app
|
||||
|
||||
Ce fichier est le manifeste de votre application. Il permet au serveur d'identifier celle ci et de récupérer des informations la concernant.
|
||||
|
||||
```yaml
|
||||
---
|
||||
# L'identifiant de votre application. Il doit être globalement unique.
|
||||
# Un identifiant du type nom de domaine inversé est en général conseillé (ex: tld.mycompany.myapp)
|
||||
id: tld.mycompany.myapp
|
||||
|
||||
# Le titre de votre application.
|
||||
title: My App
|
||||
|
||||
# Les mots-clés associés à votre applications.
|
||||
tags: ["chat"]
|
||||
|
||||
# La description de votre application.
|
||||
# Vous pouvez utiliser la syntaxe Markdown pour la mettre en forme.
|
||||
description: |>
|
||||
A simple demo application
|
||||
```
|
||||
[Voir le fichier `manifest.yml` d'exemple](./manifest.md)
|
||||
|
||||
## 4. Créer la page d'accueil
|
||||
|
||||
|
Reference in New Issue
Block a user