Déployez votre propre copie de ce modèle en quelques clics!
Ce modèle a un tas de dossiers, d'exemples de code et de configurations. N'hésitez pas à les éditer ou à les supprimer, y compris cette lecture!
Personnalisez et profitez!
Ce projet présente tous les derniers outils et bonnes pratiques en développement Web!
$ git clone https://github.com/ < YOUR-GITHUB-LOGIN > / < NAME-OF-YOUR-GENERATED-REPOSITORY > .gitAvant de pouvoir commencer à développer votre super application, vous devez installer les dépendances du projet.
Déplacez-vous à la racine du projet:
$ cd < NAME-OF-YOUR-GENERATED-REPOSITORY >Pour les prochaines étapes, choisissez un gestionnaire de package de votre choix et modifiez les commandes contenues dans les scripts
package.json. Voir leur documentation pour plus d'informations:
- Pnpm (recommande)
- NPM
Installez toutes les dépendances du projet:
# PNPM
$ pnpm install
# NPM
$ npm installUne fois toutes les dépendances installées, vous pouvez exécuter le serveur de développement local:
# PNPM
$ pnpm dev
# NPM
$ npm run devMaintenant, juste code!
Après avoir appliqué les modifications, vous pouvez générer une version pour tester et / ou déployer dans votre environnement de production.
Faire une construction de production:
# PNPM
$ pnpm build
# NPM
$ npm run buildPuis exécutez la construction:
# PNPM
$ pnpm start
# NPM
$ npm start # PNPM
$ pnpm run lint
# NPM
$ npm run lint # PNPM
$ pnpm run lint:fix
# NPM
$ npm run lint:fix # PNPM
$ pnpm run test # or pnpm run test:watch
# NPM
$ npm run test # or npm run test:watch # PNPM
$ pnpm run type-check
# NPM
$ npm run type-check # PNPM
$ pnpm run format
# NPM
$ npm run format # PNPM
$ pnpm run up
# NPM
$ npm run up # PNPM
$ pnpm run up-latest
# NPM
$ npm run up-latest # PNPM
$ pnpm run release-as-major
# NPM
$ npm run release-as-major # PNPM
$ pnpm run release-as-minor
# NPM
$ npm run release-as-minor # PNPM
$ pnpm run release-as-patch
# NPM
$ npm run release-as-patch # PNPM
$ pnpm run push-release
# NPM
$ npm run push-release # PNPM
$ pnpm run pull
# NPM
$ npm run pull Mettez le fichier babel.config.js (situé dans le chemin src/scripts ) dans le fichier Root et Supprimer .babelrc .
Décommente la ligne d'importation wdyr sur pages/_app.tsx .
C'est ça! Vous pouvez maintenant Monitore React Reacders!
Supprimez simplement les fichiers babel.config.js et wdyr.ts , supprimez la ligne d'importation wdyr sur pages/_app.tsx et désinstallez-le:
# PNPM
$ pnpm uninstall @welldone-software/why-did-you-render
# NPM
$ npm uninstall @welldone-software/why-did-you-renderVoir ci-dessous l'arborescence de fichiers pour comprendre la structure du projet.
Les dossiers et les fichiers marqués avec (
**) sont facultatifs, vous pouvez donc supprimer alors.
mantine-admin/
┣ .github/ # GitHub's folder configs **
┣ .husky/ # Husky's folder
┃ ┣ ? commit-msg # Commitlint git hook
┃ ┗ ? pre-commit # Lint-staged git hook
┣ .vscode/ # VSCode's workspace **
┣ public/ # Public folder
┃ ┣ static/ # Static files folder **
┃ ┃ ┣ icons/ # Icons folder **
┃ ┃ ┣ images/ # Images folder **
┃ ┃ ┣ sounds/ # Sounds folder **
┃ ┃ ┗ videos/ # Videos folder **
┃ ┣ docs/ # Documentation folder **
┃ ┃ ┣ demo/ # Demonstrations project **
┃ ┃ ┗ translations/ # Translations folder **
┃ ┣ ? favicon.ico # Icon tab browser
┣ src/
┃ ┣ app/ # App pages
┃ ┣ components/ # App Components
┃ ┃ ┗ Motion/ # Mantine-UI components **
┃ ┣ hooks/ # React Hooks **
┃ ┃ ┗ ? useFetch.ts # SWR fetch hook (optional) **
┃ ┣ interfaces/ # TypeScript Interfaces
┃ ┣ scripts/ # Additional scripts **
┃ ┃ ┣ ? babel.config.js # Babel config with WDYR **
┃ ┃ ┗ ? wdyr.ts # WDYR file **
┃ ┣ services/ # Services
┃ ┃ ┗ users/
┃ ┃ ┣ ? index.ts # React Query Configuration
┃ ┃ ┗ ? keys.ts # React Query Key
┃ ┣ stores/ # Zustand stores
┃ ┣ styles/ # Styles folder
┃ ┃ ┣ ? bgImages.ts # SVG background images **
┃ ┃ ┗ ? theme.ts # Mantine-UI theme
┃ ┗ utils/ # Useful functions **
┣ ? .babelrc # Default Babel config
┣ ? .editorconfig # Editor config
┣ ? .eslintignore # ESLint ignore
┣ ? .eslintrc # ESLint config
┣ ? .gitignore # Git ignore
┣ ? .versionrc # Versioning config
┣ ? .commitlintrc # Commitlint config
┣ ? jest.config.js # Jest config
┣ ? jest.setup.js # Jest setup
┣ ? LICENSE # License of the project
┣ ? next-env.d.ts # Next.js types to TypeScript
┣ ? next.config.js # Next.js config
┣ ? .prettierrc # Prettier config
┣ ? README.md # Main README
┣ ? renovate.json # Renovate Bot config **
┣ ? tsconfig.json # TypeScript configBien que vous n'ayez pas à le faire, si vous réutilisez ce modèle pour vos projets, je l'apprécierais si vous me crédiriez et fournissez un lien vers mon profil GitHub dans le pied de page de votre projet . Merci!
Ce projet est autorisé sous la licence MIT - voir la page de licence pour plus de détails.