arcad/edge
15
0
Fork 0
Code Issues 8 Pull Requests Projects Releases 3 Wiki Activity

feat: initial commit

Browse Source
This commit is contained in:
wpetit
2023-02-09 12:16:36 +01:00
commit 51cf581361
114 changed files with 17978 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/apps/app-manifest.md Normal file
View File

@ -0,0 +1,3 @@
# Le manifeste d'application (`arcad.yml`)
> `TODO`

3
doc/apps/client-api/README.md Normal file
View File

@ -0,0 +1,3 @@
# API Client
> `TODO`

74
doc/apps/my-first-app.md Normal file
View File

@ -0,0 +1,74 @@
# Créer ma première application
## 1. Télécharger le CLI
1. Se rendre à l'adresse https://forge.cadoles.com/arcad/edge/releases
2. Télécharger la dernière version du binaire `cli` disponible dans la page.
## 2. Créer l'arborescence de son application
L'arborescence d'une "Edge App" doit correspondre à une structure prédéfinie.
```bash
my-app
|-> arcad.yml # Le fichier "manifeste" décrivant votre application
|-> public # Répertoire contenant tous les fichiers accessibles publiquement
|-> server
|-> main.js # Le point d'entrée pour le code "serveur" de votre application
```
## 3. Compléter le fichier `arcad.yml`
Ce fichier est le manifeste de votre application. Il permet au serveur Arcad d'identifier celle ci et d'afficher ses informations dans la page d'accueil.
```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
```
## 4. Créer la page d'accueil
Créer le fichier `my-app/public/index.html`:
```html
<html>
<head>
<title>My App</title>
</head>
<body>
<h1>My App</h1>
</body>
</html>
```
## 5. Créer le fichier `server/main.js`
Ce fichier est nécessaire, même vide.
```bash
touch server/main.js
```
## 6. Exécuter votre application en local
Utiliser le CLI téléchargé préalablement pour lancer votre nouvelle application localement.
```bash
cli app run -p ./chemin/vers/app
```
La page d'accueil devrait être accessible à l'adresse http://localhost:8080.

3
doc/apps/package-app.md Normal file
View File

@ -0,0 +1,3 @@
# Empaqueter une application
> `TODO`

3
doc/apps/server-api/README.md Normal file
View File

@ -0,0 +1,3 @@
# API Serveur
> `TODO`