diff --git a/README.md b/README.md index 1fb1113..a2ceebb 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,23 @@ Framework web minimaliste basé sur JavaScript vanilla et les Web Components. Routage hash-based, composants déclarés dans `config.yml`, build via `build.sh`. +## Contenu du repo + +``` +├── template/ # Point de départ pour un nouveau projet +└── exemple/ + └── navigation/ # Exemple complet avec side-nav et page dashboard +``` + +## Démarrer un projet + +```bash +cp -r template/ mon-projet/ +cd mon-projet/ +./build.sh +python3 -m http.server 8000 --directory sources/ +``` + ## Structure d'un projet ``` @@ -15,19 +32,10 @@ Routage hash-based, composants déclarés dans `config.yml`, build via `build.sh │ ├── vendor/ # Libs tierces (gitignored) │ └── pages/ │ └── / # Une page = un dossier -├── config.yml # Source de vérité +├── config.yml # Source de vérité └── build.sh # Télécharge les remotes + génère les JSON ``` -## Démarrer un projet - -```bash -cp -r template/ mon-projet/ -cd mon-projet/ -./build.sh -python3 -m http.server 8000 --directory sources/ -``` - ## Ajouter une page 1. Créer `sources/pages//` avec : diff --git a/build.sh b/exemple/navigation/build.sh similarity index 100% rename from build.sh rename to exemple/navigation/build.sh diff --git a/config.yml b/exemple/navigation/config.yml similarity index 100% rename from config.yml rename to exemple/navigation/config.yml diff --git a/sources/components.lock.json b/exemple/navigation/sources/components.lock.json similarity index 100% rename from sources/components.lock.json rename to exemple/navigation/sources/components.lock.json diff --git a/sources/components/.keep b/exemple/navigation/sources/components/.keep similarity index 100% rename from sources/components/.keep rename to exemple/navigation/sources/components/.keep diff --git a/sources/config.json b/exemple/navigation/sources/config.json similarity index 100% rename from sources/config.json rename to exemple/navigation/sources/config.json diff --git a/sources/core/config.js b/exemple/navigation/sources/core/config.js similarity index 100% rename from sources/core/config.js rename to exemple/navigation/sources/core/config.js diff --git a/sources/core/menu.js b/exemple/navigation/sources/core/menu.js similarity index 100% rename from sources/core/menu.js rename to exemple/navigation/sources/core/menu.js diff --git a/sources/core/registry.js b/exemple/navigation/sources/core/registry.js similarity index 100% rename from sources/core/registry.js rename to exemple/navigation/sources/core/registry.js diff --git a/sources/core/router.js b/exemple/navigation/sources/core/router.js similarity index 100% rename from sources/core/router.js rename to exemple/navigation/sources/core/router.js diff --git a/sources/favicon.svg b/exemple/navigation/sources/favicon.svg similarity index 100% rename from sources/favicon.svg rename to exemple/navigation/sources/favicon.svg diff --git a/sources/icons.json b/exemple/navigation/sources/icons.json similarity index 100% rename from sources/icons.json rename to exemple/navigation/sources/icons.json diff --git a/sources/index.html b/exemple/navigation/sources/index.html similarity index 100% rename from sources/index.html rename to exemple/navigation/sources/index.html diff --git a/sources/pages/dashboard/dashboard.css b/exemple/navigation/sources/pages/dashboard/dashboard.css similarity index 100% rename from sources/pages/dashboard/dashboard.css rename to exemple/navigation/sources/pages/dashboard/dashboard.css diff --git a/sources/pages/dashboard/dashboard.js b/exemple/navigation/sources/pages/dashboard/dashboard.js similarity index 100% rename from sources/pages/dashboard/dashboard.js rename to exemple/navigation/sources/pages/dashboard/dashboard.js diff --git a/sources/pages/dashboard/index.html b/exemple/navigation/sources/pages/dashboard/index.html similarity index 100% rename from sources/pages/dashboard/index.html rename to exemple/navigation/sources/pages/dashboard/index.html diff --git a/sources/pages/dashboard/manifest.json b/exemple/navigation/sources/pages/dashboard/manifest.json similarity index 100% rename from sources/pages/dashboard/manifest.json rename to exemple/navigation/sources/pages/dashboard/manifest.json diff --git a/sources/vendor/.keep b/exemple/navigation/sources/vendor/.keep similarity index 100% rename from sources/vendor/.keep rename to exemple/navigation/sources/vendor/.keep