Structure du projet

Ce document fournit un aperçu des principaux répertoires et fichiers du projet NuxSaaS. Il vise à aider les contributeurs et les utilisateurs à comprendre rapidement l’organisation de la base de code.

Structure principale

NuxSaaS/
├── .env.example
├── .github/
├── .vscode/
├── app/
├── public/
├── server/
├── tests/
├── eslint.config.mjs
├── nuxt.config.ts
├── package.json
├── tsconfig.json
├── vitest.config.ts
└── wrangler.example.toml

Aperçu des répertoires et fichiers

.env.example

Modèle pour les variables d’environnement. À copier et renommer en .env pour votre configuration locale.

.github/

Fichiers de configuration GitHub, tels que le financement et les définitions de workflows.

.vscode/

Paramètres de l’espace de travail VS Code, recommandations d’extensions et configurations de débogage.

app/

Contient tout le code de l’application frontend :

• app.vue, app.config.ts : Point d’entrée principal et configuration de l’application Nuxt.
• assets/ : Ressources statiques (CSS, images, etc.).
• components/ : Composants Vue.
• composables/ : Utilitaires réutilisables basés sur l’API de composition.
• i18n/ : Ressources d’internationalisation.
• layouts/ : Composants de mise en page pour différentes structures de pages.
• middleware/ : Middleware de routage frontend.
• pages/ : Pages Nuxt, mappées aux routes.
• plugins/ : Plugins Nuxt pour étendre les fonctionnalités de l’application.
• utils/ : Fonctions utilitaires et définitions de types.

public/

Fichiers statiques servis à la racine du site, tels que favicons, logos et captures d’écran.

server/

Code backend/côté serveur :

• api/ : Gestionnaires de routes API.
• database/ : Configuration et schéma de la base de données.
• middleware/ : Middleware côté serveur.
• utils/ : Utilitaires côté serveur.

tests/

Fichiers de tests automatisés, y compris les tests end-to-end (e2e) et les scripts de configuration.

eslint.config.mjs

Configuration ESLint pour le linting et l’application du style de code.

nuxt.config.ts

Fichier principal de configuration Nuxt, définissant les modules, plugins, paramètres d’exécution, etc.

package.json

Métadonnées du projet, scripts et dépendances.

tsconfig.json

Configuration TypeScript pour l’ensemble du projet.

vitest.config.ts

Configuration du framework de tests Vitest.

wrangler.example.toml

Exemple de configuration pour le déploiement sur Cloudflare Workers avec Wrangler.

---

Pour plus de détails sur le flux de développement, la configuration de l’environnement et les outils recommandés, veuillez consulter les autres guides de ce répertoire.