? Ringkasan
Easyreadme adalah proyek yang menyederhanakan penciptaan readme dengan menghasilkan readmes yang menakjubkan secara visual menggunakan template dan AI yang telah dirancang sebelumnya. Ini mendukung pembuatan readmes untuk proyek JavaScript/TypeScript, Rust, Java, GO, PHP, dan Python. Ini bergantung pada berbagai teknologi dan perpustakaan termasuk React, Tailwind CSS, Tiptap, Openai, dan banyak lagi.
? Daftar isi
❤️ fitur
Tumpukan
Ringkasan Proyek
Menyiapkan
Jalankan secara lokal
? Roadmap
Ucapan Terima Kasih
? Lisensi
Fitur
Pendahuluan.mp4
Daftar template
template.mp4
Kustomisasi ReadMe
customize.mp4
Bagian AI
AI-section.mp4
Perintah inline
commands.mp4
Menu gelembung
Bubble-menu.mp4
URL gambar spanduk yang dapat diedit
Update-Banner.mp4
Kredit AI Gratis, Kunci API Kustom, Run Lokal
API-OFFLINE-GENERATIONS.MP4
Tumpukan
- Berikutnya: Kerangka kerja untuk membangun aplikasi bereaksi yang diseret server.
- Bereaksi: Perpustakaan JavaScript untuk membangun antarmuka pengguna.
- TypeScript: Superset JavaScript yang diketik yang dikompilasi ke JavaScript biasa.
- Shadcn/UI: Menyediakan komponen yang dirancang dengan indah untuk UI.
- TailwindCSS: Kerangka kerja CSS utilitas-pertama untuk pengembangan UI yang cepat.
- Vaul: Komponen laci yang tidak terhubung untuk bereaksi.
- Sonner: Komponen roti panggang yang bereaksi untuk bereaksi.
- TipTap/Core: Kerangka kerja editor teks kaya yang sangat dapat disesuaikan dan diperpanjang.
- SWR: Menangani pengambilan data, caching, dan sinkronisasi dengan server.
- Zustand: Perpustakaan manajemen negara yang kecil, cepat, dan dapat diskalakan.
- Lucide: Ikon cantik & konsisten.
Ringkasan Proyek
- SRC : Direktori Kode Sumber Utama.
- SRC/APP : Berisi logika dan komponen aplikasi utama.
- SRC/KOMPONEN : Rumah -rumah komponen UI yang dapat digunakan kembali.
- SRC/HOOKS : Kait reaksi khusus untuk mengelola status dan efek samping.
- SRC/LIB : Fungsi Utilitas dan Modul Pembantu.
- SRC/Layanan : Modul untuk berinteraksi dengan API eksternal.
- SRC/Styles : Global Styles dan Modul CSS.
- SRC/TYPE : Definisi Jenis TypeScript.
- SRC/Utils : Fungsi Utilitas Lain -lain.
- Publik : Direktori Publik untuk Aset Statis dan Membangun Output.
Menyiapkan
Openai_api_key
- Buka situs web OpenAI.
- Masuk ke akun Anda atau buat yang baru.
- Arahkan ke pengaturan API Anda.
- Menghasilkan kunci rahasia.
- Salin kunci rahasia yang dihasilkan.
Github_access_token
- Buka situs web GitHub.
- Masuk ke akun Anda atau buat yang baru.
- Arahkan ke pengaturan akun Anda.
- Buka bagian "Pengaturan Pengembang".
- Menghasilkan token akses pribadi baru dengan izin yang diperlukan.
Kv_rest_api_url dan kv_rest_api_token
- Buka situs web Vercel.
- Masuk ke akun Anda atau buat yang baru.
- Arahkan ke bagian penyimpanan.
- Buat database KV baru.
- Salin kv_rest_api_url dan kv_rest_api_token dari bawah tab .env.local .
Ollama_url
- Unduh Ollama dan beroperasi.
- Jika instance ollama Anda tidak berjalan di alamat dan port IP default, ubah variabel dalam file .env.example agar sesuai dengan usecase Anda
Jalankan secara lokal
1.Clone The Easyreadme Repository:
git clone https://github.com/xavimondev/easyreadme
2.Rename .env.example to .env :
3. Instalasi Ketergantungan:
# bun
bun install
# pnpm
pnpm install
# npm
npm install
# yarn
yarn install
6. Mulai mode pengembangan:
# bun
bun dev
# pnpm
pnpm dev
# npm
npm run dev
# yarn
yarn dev
Penting
Meskipun memiliki template untuk paket NPM, masih ada banyak pekerjaan yang harus dilakukan dan penelitian tentang cara mendapatkan jenis yang benar dari paket.
Peta jalan
Ucapan Terima Kasih
- Animasi Sparkles diambil dari sumber daya hebat yang dibuat oleh Josh W. Comeau ini
- Tombol confetti di sekitar tombol "Salin kode" dibuat menggunakan web Lucide sebagai referensi.
Lisensi
Proyek ini dilisensikan di bawah lisensi MIT - lihat file lisensi MIT untuk detailnya.
