sticky memo

Mémo

Sticky-Memo est une application de notes collante construite à l'aide de React.js et Vite. Cette documentation vous guidera tout au long du processus de contribution à ce projet.

Table des matières

• Installation
  • Cloner le référentiel
  • Installation du frontend
• Structure du projet
• Contributif
  • Faire le référentiel
  • Cloner le référentiel
  • Créer une branche
  • Apporter des changements
  • Commettre des changements
  • Pousser les changements
  • Créer une demande de traction
• Contributeurs
• Licence

Installation

Cloner le référentiel

1. Fourk le référentiel en cliquant sur le bouton "Fork" en haut à droite de la page du référentiel sur GitHub.
2. Clone votre référentiel à fourche vers votre machine locale:

   git clone https://github.com/your-username/Sticky-Memo.git

3. Accédez au répertoire du projet:

    cd Sticky-Memo

Installation du frontend

Après le clonage du référentiel:

1. Installez les dépendances :

   npm install

2. Démarrer le serveur de développement :

   npm run dev

Structure du projet

Projet

Le répertoire frontend contient l'application React.

• public : contient les actifs publics de la demande.
• src : contient le code source de l'application.
  • components : composants d'interface utilisateur réutilisables.
    • list of components : liste de tous les composants
  • pages : pages
    • list of pages : liste de toutes les pages
  • styles : style
    • list of styles : liste de tous les feuilles de style
  • utils
    • list of utils : liste de tous les services publics
• App.jsx : le composant principal qui configure les routes.
• main.jsx : le point d'entrée de l'application React.

Contributif

Nous accueillons les contributions! Pour contribuer à Sticky-Memo, suivez ces étapes:

Faire le référentiel

1. Fourk le référentiel en cliquant sur le bouton "Fork" en haut à droite de la page du référentiel sur GitHub.

Cloner le référentiel

2. Clone votre référentiel à fourche vers votre machine locale:

   git clone https://github.com/your-username/Sticky-Memo.git

3. Accédez au répertoire du projet:

    cd Sticky-Memo

Créer une branche

4. Créez une nouvelle branche pour votre fonctionnalité ou votre correction de bogue (créez une branche en fonction du problème qui fonctionne):

   git switch -c your-branch-name

Apporter des changements

5. Apportez vos modifications à la base de code. Vous pouvez modifier les fichiers à l'aide de votre éditeur de code préféré.

Commettre des changements

6. Ajouter les modifications à la zone de mise en scène:

   git add .

7. Commettre les modifications avec un message descriptif:

   git commit -m " Description of your changes "

Pousser les changements

8. Poussez les modifications à votre référentiel fourchu:

   git push origin your-branch-name

Créer une demande de traction

9. Créez une demande de traction de votre référentiel à fourche vers le référentiel principal. Accédez à l'onglet "Pull Demandes" dans le référentiel principal, puis cliquez sur "Nouvelle demande de pull". Suivez les instructions pour créer votre demande de traction.

Contributeurs

Nous apprécions les contributions des individus suivants: contributeurs

Ce n'est que le début! J'ai hâte de faire des contributions plus significatives et de collaborer avec cette communauté incroyable. Construisons quelque chose de super ensemble et faisons de la mémo autocollante le meilleur possible! ❤️?

Licence

Ce projet est autorisé en vertu de la licence MIT - voir le fichier de licence pour plus de détails.