Readmeify adalah sebuah alat yang dirancang untuk membantu pengembang dalam membuat dan mengelola dokumentasi proyek dengan lebih efisien. Dengan memanfaatkan framework Laravel dan teknologi modern lainnya, Readmeify memungkinkan pengguna untuk menghasilkan README.md yang informatif dan menarik dengan cepat.
- ✅ Integrasi Laravel: Memanfaatkan kekuatan Laravel untuk pengembangan aplikasi yang cepat dan efisien.
- ✅ Dukungan Tailwind CSS: Menggunakan Tailwind CSS untuk styling yang responsif dan modern.
- ✅ Generasi Otomatis: Fitur untuk menghasilkan bagian-bagian README.md secara otomatis berdasarkan konfigurasi yang diberikan.
- ✅ Dukungan PHP dan JavaScript: Mengelola dependensi dengan mudah menggunakan Composer dan npm.
- ✅ Pengujian yang Efisien: Menggunakan Faker dan Laravel Tinker untuk pengujian yang lebih baik dan lebih cepat.
Ikuti langkah-langkah di bawah ini untuk menginstal Readmeify di lingkungan pengembangan Anda.
-
Clone Repository: Langkah ini diperlukan untuk mendownload salinan kode sumber proyek ke komputer Anda.
git clone https://github.com/DanU-R/Readmeify.git
-
Install Dependencies: Anda perlu menginstal semua dependensi PHP dan JS yang diperlukan untuk menjalankan proyek ini.
composer install && npm install -
Environment Setup: Salin file contoh konfigurasi lingkungan untuk mengatur kredensial database Anda.
cp .env.example .env
-
Key & Database: Hasilkan kunci aplikasi dan lakukan migrasi database untuk menyiapkan tabel yang diperlukan.
php artisan key:generate && php artisan migrate -
Serve: Jalankan perintah ini untuk memulai aplikasi dan melihatnya di browser Anda.
npm run build && php artisan serve
Kontribusi sangat diharapkan! Silakan ajukan permintaan tarik (pull request) atau laporkan masalah (issues) untuk membantu meningkatkan proyek ini.
Proyek ini dilisensikan di bawah MIT License.