sticky memo

Klebriger Memo

Sticky-Memo ist eine klebrige Notizenanwendung, die mit React.js und vite erstellt wurde. Diese Dokumentation führt Sie durch den Prozess des Beitrags zu diesem Projekt.

Inhaltsverzeichnis

• Installation
  • Klonen Sie das Repository
  • Frontend -Installation
• Projektstruktur
• Beitragen
  • Gabel des Repositorys
  • Klonen des Repositorys
  • Erstellen eines Zweigs
  • Änderungen vornehmen
  • Änderungen begehen
  • Änderungen drücken
  • Erstellen einer Pull -Anfrage
• Mitwirkende
• Lizenz

Installation

Klonen Sie das Repository

1. Geben Sie das Repository auf die Schaltfläche "Fork" oben rechts auf der Repository -Seite auf GitHub.
2. Klonen Sie Ihr Gabel -Repository in Ihre lokale Maschine:

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

3. Navigieren Sie zum Projektverzeichnis:

    cd Sticky-Memo

Frontend -Installation

Nach dem Klonen des Repositorys:

1. Installieren Sie die Abhängigkeiten :

   npm install

2. Starten Sie den Entwicklungsserver :

   npm run dev

Projektstruktur

Projekt

Das frontend -Verzeichnis enthält die React -Anwendung.

• public : Enthält die öffentlichen Vermögenswerte des Antrags.
• src : Enthält den Quellcode der Anwendung.
  • components : Wiederverwendbare UI -Komponenten.
    • list of components : Liste aller Komponenten
  • pages : Seiten
    • list of pages : Liste aller Seiten
  • styles : Styling
    • list of styles : Liste aller Stylesheets
  • utils
    • list of utils : Liste aller Dienstprogramme
• App.jsx : Die Hauptkomponente, die Routen einrichtet.
• main.jsx : Der Einstiegspunkt der React -Anwendung.

Beitragen

Wir begrüßen Beiträge! Folgen Sie folgenden Schritten, um zu klebrigen Memo beizutragen:

Gabel des Repositorys

1. Geben Sie das Repository auf die Schaltfläche "Fork" oben rechts auf der Repository -Seite auf GitHub.

Klonen des Repositorys

2. Klonen Sie Ihr Gabel -Repository in Ihre lokale Maschine:

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

3. Navigieren Sie zum Projektverzeichnis:

    cd Sticky-Memo

Erstellen eines Zweigs

4. Erstellen Sie eine neue Filiale für Ihre Funktion oder Ihre Fehlerbehebung (erstellen Sie eine Zweigstelle gemäß dem Problem, an dem wir arbeiten):

   git switch -c your-branch-name

Änderungen vornehmen

5. Nehmen Sie Ihre Änderungen an der Codebasis vor. Sie können die Dateien mit Ihrem bevorzugten Code -Editor bearbeiten.

Änderungen begehen

6. Fügen Sie die Änderungen in den Staging -Bereich hinzu:

   git add .

7. Beachten Sie die Änderungen mit einer beschreibenden Nachricht:

   git commit -m " Description of your changes "

Änderungen drücken

8. Drücken Sie die Änderungen in Ihr Gabel -Repository:

   git push origin your-branch-name

Erstellen einer Pull -Anfrage

9. Erstellen Sie eine Pull -Anfrage aus Ihrem Gabel -Repository im Hauptrepository. Gehen Sie auf der Registerkarte "Pull -Anforderungen" im Hauptrepository und klicken Sie auf "Neue Pull Request". Befolgen Sie die Anweisungen, um Ihre Pull -Anfrage zu erstellen.

Mitwirkende

Wir schätzen die Beiträge der folgenden Personen: Mitwirkende

Dies ist nur der Anfang! Ich freue mich darauf, sinnvollere Beiträge zu leisten und mit dieser erstaunlichen Gemeinschaft zusammenzuarbeiten. Lass uns zusammen etwas Großartiges bauen und klebrige Memo so gut wie möglich machen! ❤️?

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert - Einzelheiten finden Sie in der Lizenzdatei.