Documentation d'aarshi

aarshi crée pour vous un site Next.js multilingue, puis vous aide à le garder en ordre.

Qu'est-ce qu'aarshi ?

Un site Next.js, ce sont beaucoup de fichiers : des pages, des textes dans plusieurs langues, des composants, un plan du site pour les moteurs de recherche. aarshi écrit les fichiers de départ et vous donne de petites commandes pour ajouter des pages, des sections, des langues et des icônes, sans copier les fichiers à la main.

Pas besoin de connaître Next.js pour commencer. Les autres pages de cette documentation sont listées dans le menu de gauche :

Le fichier aarshi.toml: Ce que contient le fichier de réglages d'un projet, et les valeurs que vous pouvez changer.
Commandes: Chaque commande, avec aarshi add expliqué pas à pas.
Exemple pas à pas: Un tutoriel qui construit une page du début à la fin, en utilisant presque toutes les commandes.
Vérifier un projet: aarshi status : ce qu'il signale, ses codes de sortie et ses options.
Dépannage: Les messages que vous rencontrerez le plus souvent, et quoi faire.

Avant de commencer

Node.js, l'environnement d'exécution sur lequel tourne Next.js.
Un gestionnaire de paquets : npm (installé avec Node.js), pnpm, yarn ou bun.
Une connexion internet pendant setup, car le projet et ses dépendances sont téléchargés.
Un terminal. Chaque commande de cette documentation s'y tape.

Installer aarshi

aarshi est écrit en Rust et n'est pas encore publié. Pour l'instant, compilez-le depuis le dépôt :

cargo install --path .

Vérifiez ensuite que la commande répond :

aarshi --version

Créer votre premier site

Lancez aarshi setup mon-site. aarshi pose des questions sur les langues, la langue par défaut, l'URL du site, le gestionnaire de paquets, les composants d'interface et les icônes. Appuyez sur Entrée pour garder la réponse proposée.
Entrez dans le dossier : cd mon-site.
Démarrez le serveur de développement avec votre gestionnaire de paquets, par exemple npm run dev.
Ouvrez http://localhost:3000 dans votre navigateur. Le site vous redirige vers sa langue par défaut.

Astuce. Ajoutez --yes pour accepter toutes les valeurs par défaut sans répondre aux questions : aarshi setup mon-site --yes. Le nom du dossier reste obligatoire.

Les mots que vous rencontrerez

Langue et préfixe: Chaque langue du site a un préfixe dans l'adresse : /fr pour le français, /en pour l'anglais. La langue par défaut est celle servie à /.
Dictionnaire: Un fichier qui contient tous les textes du site dans une langue, par exemple lib/i18n/dictionaries/fr.ts. Chaque langue en a un, avec les mêmes clés : une traduction manquante se voit.
Vue: Ce qu'affiche une page, écrit dans views/<page>/. Une vue est assemblée à partir de sections.
Section: Un bloc d'une page, comme une bannière d'accueil, une liste de projets ou un pied de page. Chaque section est un fichier de views/<page>/sections/.
Route: Le fichier qui rend une page accessible à une adresse, par exemple app/[locale]/a-propos/page.tsx pour /a-propos. Une route affiche une vue.
Composant: Un morceau d'interface réutilisable, comme un bouton. Vos propres composants vont dans components/custom/, les icônes converties dans components/icons/.