Bereiten Sie Ihre eigene Kopie dieser Vorlage in nur wenigen Klicks ein!
Diese Vorlage verfügt über eine Reihe von Ordnern, Codebeispielen und Konfigurationen. Fühlen Sie sich frei, sie zu bearbeiten oder zu entfernen, einschließlich dieser Readme!
Anpassen und genießen!
Dieses Projekt verfügt über die neuesten Tools und guten Praktiken in der Webentwicklung!
$ git clone https://github.com/ < YOUR-GITHUB-LOGIN > / < NAME-OF-YOUR-GENERATED-REPOSITORY > .gitBevor Sie mit der Entwicklung Ihrer Superanwendung beginnen können, müssen Sie die Abhängigkeiten des Projekts installieren.
Bewegen Sie sich zur Wurzel des Projekts:
$ cd < NAME-OF-YOUR-GENERATED-REPOSITORY >Wählen Sie für die nächsten Schritte einen Paketmanager Ihrer Wahl und ändern Sie die im
package.json-Skripte enthaltenen Befehle. Weitere Informationen finden Sie in der Dokumentation:
- PNPM (Empfehlung)
- NPM
Installieren Sie alle Abhängigkeiten des Projekts:
# PNPM
$ pnpm install
# NPM
$ npm installSobald alle Abhängigkeiten installiert wurden, können Sie den lokalen Entwicklungsserver ausführen:
# PNPM
$ pnpm dev
# NPM
$ npm run devJetzt nur codieren!
Nachdem Sie die Änderungen angewendet haben, können Sie einen Build zum Testen und/oder Bereitstellen in Ihrer Produktionsumgebung erstellen.
Machen Sie einen Produktionsbau:
# PNPM
$ pnpm build
# NPM
$ npm run buildUnd dann den Build ausführen:
# 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 Legen Sie die Datei babel.config.js (im Pfad src/scripts ) in die Projektstamme und löschen Sie .babelrc -Datei.
Überfassen Sie die wdyr -Importzeile auf pages/_app.tsx .
Das war's! Jetzt können Sie React React React-Renders überwachen!
Löschen Sie einfach die Dateien babel.config.js und wdyr.ts , entfernen Sie wdyr -Importzeile auf pages/_app.tsx und deinstallieren Sie es:
# PNPM
$ pnpm uninstall @welldone-software/why-did-you-render
# NPM
$ npm uninstall @welldone-software/why-did-you-renderSiehe unten in der Dateibaum, um die Projektstruktur zu verstehen.
Ordner und Dateien mit (
**) sind optional, sodass Sie dann löschen können.
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 configObwohl Sie es nicht müssen, wenn Sie diese Vorlage für Ihre Projekte wiederverwenden würden, würde ich es zu schätzen freuen, wenn Sie mir einen Link zu meinem Github -Profil im Fußzeile Ihres Projekts angeben würden. Danke!
Dieses Projekt ist unter der MIT -Lizenz lizenziert - Einzelheiten finden Sie auf der Lizenzseite.