markdown zen

Penurunan hargaZen

MarkdownZen adalah aplikasi web yang dirancang untuk menyederhanakan pembuatan dan pengelolaan dokumen penurunan harga. Dengan antarmuka yang ramah pengguna dan fitur canggih, MarkdownZen adalah alat pilihan Anda untuk pengalaman penurunan harga yang luar biasa.

Daftar isi

• Memulai
  • Prasyarat
  • Instalasi
• Penggunaan
• Fitur
• Berjalan Dengan Docker
• Berkontribusi
• Lisensi

Memulai

Prasyarat

Sebelum memulai, pastikan Anda telah menginstal perangkat lunak berikut di komputer Anda:

• Node.js
• npm (Manajer Paket Node)

Instalasi

1. Kloning repositori :

   Buka terminal/command prompt Anda dan arahkan ke lokasi di mana Anda ingin menyimpan proyek. Kemudian, jalankan perintah berikut:

git clone https://github.com/daniel752/markdown-zen.git

Ini akan mengunduh file proyek ke komputer Anda.

2. Arahkan ke folder proyek :

Gunakan perintah cd untuk mengubah direktori kerja Anda ke folder proyek kloning:

cd markdown-zen

3. Instal Dependensi :

Di dalam folder proyek, instal dependensi yang diperlukan untuk server dan klien menggunakan satu perintah:

npm run setup-project

Ini akan menginstal paket yang diperlukan untuk komponen server dan klien aplikasi.

Penggunaan

1. Mulai Aplikasi :

Untuk meluncurkan aplikasi, jalankan perintah berikut di folder root (markdown-zen/):

npm run dev

Perintah ini memulai server dan klien secara bersamaan, sehingga Anda dapat mengakses aplikasi di browser Anda.

2. Akses Aplikasi :

Buka browser web Anda dan buka http://localhost:5173 . Di sinilah Anda akan menemukan aplikasi MarkdownZen.

3. Membuat dan Mengelola Penurunan Harga :

• Masuk atau buat akun.
• Mulai membuat dan mengelola dokumen penurunan harga Anda dengan mudah.

Fitur

• Buat, edit, dan kelola dokumen penurunan harga dengan mudah.
• Pratinjau penurunan harga waktu nyata saat mengedit.
• Atur penurunan harga menggunakan kategori dan tag.
• Sistem otentikasi dan otorisasi yang aman.
• ...

Berjalan dengan Docker

Anda juga dapat menjalankan MarkdownZen menggunakan Docker. Ikuti langkah-langkah berikut:

1. Tarik Gambar Docker :

   Tarik image MarkdownZen Docker dari Docker Hub:

   docker pull daniel752/markdown-zen:v1.0.0
   

2. Jalankan Kontainer :

   Mulai wadah MarkdownZen:

   docker run -d daniel752/markdown-zen:v1.0.0
   
   

• -d: Jalankan container dalam mode terpisah (di latar belakang).
• Kontainer akan menjalankan port 8000 di dalam dan 5173 di luar.

Berkontribusi

Kami menyambut kontribusi dari komunitas! Untuk berkontribusi ke MarkdownZen, ikuti langkah-langkah berikut:

1. Garpu Repositori :

Klik tombol "Fork" di kanan atas halaman repositori GitHub. Ini membuat salinan repositori di bawah akun GitHub Anda.

2. Kloning Garpu Anda :

Kloning repositori bercabang Anda ke mesin lokal Anda:

git clone https://github.com/your-username/markdown-zen.git

3. Buat Cabang Baru :

Ubah ke direktori proyek:

cd markdown-zen

Buat cabang baru untuk fitur Anda:

git checkout -b feature/my-new-feature

4. Lakukan Perubahan :

Buat perubahan yang diperlukan dan lakukan:

git commit -m 'Add some feature'

5. Dorong Perubahan Anda :

Dorong perubahan Anda ke repositori bercabang Anda:

git push origin feature/my-new-feature

6. Kirim Permintaan Tarik :

Kunjungi repositori asli di GitHub dan klik tombol "Permintaan Tarik Baru" untuk mengirimkan perubahan Anda untuk ditinjau.

Lisensi

Proyek ini dilisensikan di bawah Lisensi MIT. Lihat file LISENSI untuk detailnya.