sticky memo

Sticky-memo

Sticky-memo adalah aplikasi Sticky Notes yang dibangun menggunakan react.js dan vite. Dokumentasi ini akan memandu Anda melalui proses berkontribusi pada proyek ini.

Daftar isi

• Instalasi
  • Klon Repositori
  • Instalasi Frontend
• Struktur proyek
• Berkontribusi
  • Forking repositori
  • Mengkloning repositori
  • Membuat cabang
  • Membuat perubahan
  • Melakukan perubahan
  • Mendorong perubahan
  • Membuat Permintaan Tarik
• Kontributor
• Lisensi

Instalasi

Klon Repositori

1. Fork Repositori dengan mengklik tombol "Fork" di kanan atas halaman repositori di GitHub.
2. Klone repositori bercabang Anda ke mesin lokal Anda:

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

3. Arahkan ke Direktori Proyek:

    cd Sticky-Memo

Instalasi Frontend

Setelah mengkloning repositori:

1. Instal dependensi :

   npm install

2. Mulai server pengembangan :

   npm run dev

Struktur proyek

Proyek

Direktori frontend berisi aplikasi React.

• public : Berisi aset publik dari aplikasi.
• src : Berisi kode sumber aplikasi.
  • components : Komponen UI yang dapat digunakan kembali.
    • list of components : Daftar semua komponen
  • pages : Halaman
    • list of pages : Daftar semua halaman
  • styles : Styling
    • list of styles : Daftar semua stylesheets
  • utils
    • list of utils : Daftar semua utilitas
• App.jsx : Komponen utama yang mengatur rute.
• main.jsx : Titik masuk aplikasi React.

Berkontribusi

Kami menyambut kontribusi! Untuk berkontribusi pada Sticky-Memo, ikuti langkah-langkah ini:

Forking repositori

1. Fork Repositori dengan mengklik tombol "Fork" di kanan atas halaman repositori di GitHub.

Mengkloning repositori

2. Klone repositori bercabang Anda ke mesin lokal Anda:

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

3. Arahkan ke Direktori Proyek:

    cd Sticky-Memo

Membuat cabang

4. Buat cabang baru untuk fitur atau perbaikan bug Anda (buat cabang sesuai dengan masalah yang sedang dikerjakan):

   git switch -c your-branch-name

Membuat perubahan

5. Buat perubahan Anda pada basis kode. Anda dapat mengedit file menggunakan editor kode pilihan Anda.

Melakukan perubahan

6. Tambahkan perubahan pada area pementasan:

   git add .

7. Melakukan perubahan dengan pesan deskriptif:

   git commit -m " Description of your changes "

Mendorong perubahan

8. Dorong perubahan ke repositori bercabang Anda:

   git push origin your-branch-name

Membuat Permintaan Tarik

9. Buat permintaan tarik dari repositori bercabang Anda ke repositori utama. Buka tab "Tarik Permintaan" di repositori utama, dan klik "Permintaan Tarik Baru". Ikuti instruksi untuk membuat permintaan tarik Anda.

Kontributor

Kami menghargai kontribusi individu -individu berikut: Kontributor

Ini baru permulaan! Saya berharap dapat memberikan kontribusi yang lebih bermakna dan berkolaborasi dengan komunitas yang luar biasa ini. Mari kita membangun sesuatu yang hebat bersama dan buat pemiju lengket yang terbaik! ❤️?

Lisensi

Proyek ini dilisensikan di bawah lisensi MIT - lihat file lisensi untuk detailnya.