
@La meilleure façon de commencer avec ce modèle est d'utiliser Create Next App.
# pnpm
pnpm create next-app -e https://github.com/jpedroschmitz/typescript-nextjs-starter
# yarn
yarn create next-app -e https://github.com/jpedroschmitz/typescript-nextjs-starter
# npm
npx create-next-app -e https://github.com/jpedroschmitz/typescript-nextjs-starter
Pour démarrer le projet localement, exécutez:
pnpm dev Ouvrez http://localhost:3000 avec votre navigateur pour voir le résultat.
"Ce démarreur est de loin le meilleur démarreur de type dactylographié pour la fonction Next.js.s emballés mais non opinés en même temps!"
- Arafat Zahan
«Je peux vraiment recommander le dépôt de démarrage TypeScript suivant.
- Corfitz
«Travail brillant!»
- Soham Dasgupta
Liste des sites Web qui ont commencé avec le démarreur TypeScript Next.js:
.github - Configuration GitHub, y compris le flux de travail CI..husky - Configuration Husky et crochets.public - des actifs statiques tels que Robots.txt, Images et Favicon.src - code source d'application, y compris les pages, les composants, les styles.pnpm dev - Démarrait l'application en mode de développement sur http://localhost:3000 .pnpm build - Crée une construction de production optimisée de votre application.pnpm start - Démarrer l'application en mode de production.pnpm type-check - Valider le code à l'aide du compilateur TypeScript.pnpm lint - Exécute Eslint pour tous les fichiers du répertoire src .pnpm lint:fix - Exécute Eslint Corrict pour tous les fichiers du répertoire src .pnpm format - Exécute plus joli pour tous les fichiers du répertoire src .pnpm format:check - Vérifiez la liste plus jolie des fichiers qui doivent être formatés.pnpm format:ci - Vérification plus jolie pour CI. TypeScript est préconfiguré avec des mappages de chemins personnalisés. Pour importer des composants ou des fichiers, utilisez le préfixe @ .
import { Button } from '@/components/Button' ;
// To import images or other files from the public folder
import avatar from '@/public/avatar.png' ; Ce démarreur utilise PNPM par défaut, mais ce choix vous appartient. Si vous souhaitez passer à YARN / NPM, supprimez le fichier pnpm-lock.yaml , installez les dépendances avec YARN / NPM, modifiez le flux de travail CI et Husky Git Hooks pour utiliser les commandes YARN / NPM.
Remarque: Si vous utilisez du fil, assurez-vous de suivre ces étapes de la documentation Husky afin que les crochets GIT n'échouent pas avec le fil sur les fenêtres.
Nous utilisons T3 Env pour gérer les variables d'environnement. Créez un fichier .env.local dans la racine du projet et ajoutez vos variables d'environnement.
Lors de l'ajout de variables d'environnement supplémentaires, le schéma dans ./src/lib/env/client.ts ou ./src/lib/env/server.ts doit être mis à jour en conséquence.
Pour ajouter des redirectes, mettez à jour le tableau redirects dans ./redirects.ts . Il est dactylographié, vous obtiendrez donc une assurance automatique pour les propriétés.
La politique de sécurité du contenu (CSP) est une couche de sécurité qui aide à détecter et à atténuer certains types d'attaques, y compris les scripts inter-sites (XSS) et les attaques d'injection de données. Le CSP est implémenté dans le fichier next.config.ts .
Il contient une politique par défaut et minimale que vous pouvez personnaliser pour répondre à vos besoins d'application. C'est une base sur laquelle s'appuyer.
Ce projet est autorisé en vertu de la licence MIT - voir le fichier licence.md pour plus d'informations.