modul-ajar-generator

[!NOTE] Kenapa menggunakan teknologi ini? Kenapa tidak memakai teknologi lain? Ya karena buat ngepres budget wkwk, tapi tenang aja, teknologi yang dipilih sudah cukup mumpuni untuk kebutuhan proyek ini kok.

Memulai

Bila Anda ingin mencoba menjalankan proyek ini secara lokal, silakan ikuti petunjuk ringkas berikut:

Prasyarat

Pastikan Anda telah memasang minimum perangkat lunak berikut dalam sistem:

• Node.js v18+

Instalasi

1. Klon repositori:

   git clone https://github.com/NgodingWok/modul-ajar-generator.git
   

2. Pindah ke dalam direktori kerja:

   cd modul-ajar-generator
   

3. Instal seluruh dependensi rujukan:

   npm install
   

4. Salin file templat konfigurasi lingkungan (.env.example menjadi .env) lalu isikan kredensial (termasuk OPENAI_API_KEY) yang sesuai:

   cp .env.example .env
   

5. (Opsional) Kompilasi bundel aset TailwindCSS:

   npm run build:tailwindcss
   

6. Jalankan server pada mode development:

   npm run dev
   

7. Kunjungi aplikasi web melalui http://localhost:3000 di dalam klien peramban Anda.

Kontribusi

Setiap tambahan dan perbaikan dari para kontributor dalam proyek open source ini sangat kami hargai.

1. Lakukan Fork pada Repositori ini
2. Buat Branch terisolasi untuk penyesuaian Anda (git checkout -b feature/FiturBaruAnda)
3. Setorkan perubahannya (Commit) (git commit -m 'feat: tambah FiturBaruAnda')
4. Angkat ke Repository (Push) di rute Anda (git push origin feature/FiturBaruAnda)
5. Buka usulan penyatuan secara publik (Pull Request)

[!IMPORTANT] Jangan lupa untuk memperbarui dokumentasi dengan cara menjalankan npm run docs setelah melakukan perubahan pada kode yang mempengaruhi dokumentasi, serta jalankan npm run test untuk memastikan kualitas kode sebelum melakukan Pull Request.

Lisensi

Didistribusikan di bawah lisensi Attribution-NonCommercial 4.0 International. Harap tinjau LICENSE.md di bilik rujukan file untuk penjelasan mendetail.

Kontak

Temukan kami:

Tautan Proyek Utama: https://github.com/NgodingWok/modul-ajar-generator

Ucapan Terima Kasih

Terimakasih untuk orang-orang hebat yang telah memberikan kontribusi, baik dalam bentuk kode, ide, maupun dukungan moral untuk proyek ini. Tanpa kalian, proyek ini tidak akan pernah terwujud.

Konsultan & Auditor

• Someone, S.Pd. selaku Konsultan & Mediator
• Megawati Indah Sari, S.Pd. selaku Penyedia Data

Developer

Para pengembang yang telah berkontribusi dalam proyek ini: