📥 Installation d'Orochi

Découvrez les différentes méthodes pour installer et commencer à utiliser Orochi Framework dans vos projets.

Orochi est encore en développement actif. Certaines fonctionnalités peuvent évoluer.

Via CDN

Attention : Cette version est encore instable et peut changer sans préavis.

Pour une intégration rapide, vous pouvez utiliser le CDN en ajoutant ces liens dans le <head> de votre projet : 

<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/Orochichrys/orochi-framework@main/dist/orochi.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/Orochichrys/orochi-framework@main/dist/orochi-icons.min.css">

Et ce script avant la fermeture de la balise </body> :

<script src="https://cdn.jsdelivr.net/gh/Orochichrys/orochi-framework@main/dist/orochi.min.js"></script>

Installation locale

Téléchargez la dernière version depuis GitHub et incluez les fichiers CSS et JS dans votre projet.

1. Téléchargez la dernière version depuis le dépôt GitHub.

2. Décompressez l'archive et copiez les fichiers dans votre projet.

3. Ajoutez les liens vers les fichiers CSS dans le <head> :

<link rel="stylesheet" href="/chemin/vers/orochi.css">
<link rel="stylesheet" href="/chemin/vers/orochi-icons.css">

4. Ajoutez le script JavaScript avant la fermeture de la balise </body> : 

<script src="/chemin/vers/orochi.js"></script>

Package NPM

Le package NPM sera disponible à partir de la version 1.1+

Une fois disponible, vous pourrez installer Orochi via NPM avec la commande :

npm install orochi-css

Puis importer les fichiers dans votre projet :

import 'orochi-css/dist/orochi.css';
import 'orochi-css/dist/orochi-icons.css';
import 'orochi-css/dist/orochi.js';

Structure HTML de base

Voici un exemple de structure HTML de base pour commencer avec Orochi :

<!DOCTYPE html>
<html lang="fr">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>Mon Projet avec Orochi</title>
  <link rel="stylesheet" href="/chemin/vers/orochi.css">
  <link rel="stylesheet" href="/chemin/vers/orochi-icons.css">
</head>
<body>

  <!-- Votre contenu ici -->
  
  <script src="/chemin/vers/orochi.js"></script>
</body>
</html>

✅ Prêt à commencer !

Vous avez maintenant installé Orochi Framework. Consultez la documentation des composants pour découvrir toutes les possibilités.