svg-layout-designer-react/docs/Tutorial/Pages/PourCommencer.md
2022-10-17 12:19:40 +02:00

1.9 KiB

Pour commencer

Je vous recommande de lire README.md si ce n'est pas encore fait et de mettre en place le projet selon ce qui est écrit.

La documentation fera référence à la configuration suivante :

Si vous n'avez pas installé l'un de ces outils, je vous le recommande fortement.

Structure du projet

Commençons par nous familiariser avec la structure du projet: 90% du temps, les modifications que vous allez faire seront dans src/. Si vous souhaitez vous familiariser avec le dossier du projet, lisez Project_Structure.

Le dossier est composé de la manière suivante:

./src
├── assets
├── Components
├── dts
├── Enums
├── Events
├── Interfaces
├── test
├── tests
├── utils
├── index.scss
├── main.tsx
└── vite-env.d.ts

Le point d'entrer est le main.tsx, mais vous aurez rarement le besoin de le modifier sauf pour ajouter des fonctionnalité sur le scope global.

Les dossiers principaux que vous aurez besoin d'utiliser pour développer un nouveau composant seront : Components, Enums, Interfaces, utils (et assets si vous mettez des images ou polices d'écriture).

Les autres dossiers ne sont pas nécessaire pour faire un composant, mais sont utilisés pour développer d'autres systèmes comme les évents, les définitions typescript et les tests.

Si vous avez compris, allons à la suite et regardons les bases de React.