makeread.me Download - makeread.me Sumber Code Download

makeread.me

Data situs web

1.0.0

Unduh

Makeread.me

Generator readme yang luar biasa untuk memulai proyek Anda!

Jelajahi dokumen »

Lihat demo. Laporkan bug. Meminta fitur

Daftar isi

Daftar isi
Tentang proyek
- Dibangun dengan
Memulai
- Prasyarat
- Instalasi
Peta jalan
Berkontribusi
Lisensi
Kontak
Ucapan Terima Kasih
Melihat

Tentang proyek

Tangkapan layar

Salah satu tantangan dengan membangun dan berkontribusi pada perangkat lunak open source adalah bahwa sementara banyak proyek memiliki fungsionalitas yang luar biasa, mereka sering kehilangan untuk menjangkau audiens yang lebih luas karena kurangnya instruksi instalasi yang jelas dan ramah pengguna. Selain itu, kurangnya showcase yang efisien dari kasus penggunaannya juga berkontribusi pada jangkauan yang lebih rendah dari proyek -proyek ini.

Meskipun ada templat readme yang dapat membantu mengatasi hal ini, proses mengisi templat ini secara manual dapat memakan waktu dan membosankan. Di situlah project makeread.me masuk.

Memperkenalkan MakeRead.me, generator readme otomatis yang dapat merevolusi cara Anda membuat dokumentasi proyek Anda. Itu dirancang untuk:

Simpan waktu berharga Anda meningkatkan fokus Anda pada pengembangan,
Mengotomatiskan tugas yang berlebihan, dan,
Menerapkan prinsip -prinsip kering (jangan ulangi sendiri) untuk dokumentasi Anda.

Ini gratis, open-source, dan sangat dapat disesuaikan. Jangan ragu untuk memodifikasi templat kami agar sesuai dengan kebutuhan Anda. Jika Anda menemukan bahwa komponen tertentu hilang, Anda dipersilakan untuk berkontribusi dan memperluas proyek.

Kami memudahkan Anda untuk berkontribusi pada proyek dengan menggunakan Nunjucks dan Templat JSON untuk pemetaan terprogram. Nikmati manfaat dokumentasi proyek yang jelas dan ringkas dengan MakeRead.me!

Dibangun dengan

Proyek ini dibangun dengan teknologi berikut:

Next.js
Bereaksi
Shadcn/ui
Bentuk pengait bereaksi
Naskah
Cepat

Memulai

Ini adalah contoh bagaimana Anda dapat memberikan instruksi tentang pengaturan proyek Anda secara lokal. Untuk mendapatkan salinan lokal dan berjalan ikuti langkah -langkah contoh sederhana ini.

Prasyarat

Proyek ini membutuhkan benang untuk diinstal di sistem Anda. Jika Anda tidak menginstalnya, Anda dapat mengikuti langkah -langkah ini:

Instal benang secara global menggunakan NPM (Node Package Manager). Buka Terminal Anda dan Jalankan:
```
npm install -g yarn
```
Harap pastikan bahwa Anda memiliki Node.js dan NPM yang diinstal sebelum menjalankan benang.
Verifikasi bahwa benang telah diinstal pada mesin Anda dengan menjalankan perintah berikut di terminal Anda:
```
yarn --version
```
Jika benang telah diinstal dengan benar, terminal Anda harus menampilkan versi benang yang diinstal pada mesin Anda.

Sekarang Anda siap menggunakan benang untuk mengelola dan versi dependensi proyek Anda!

Instalasi

Harap ikuti langkah -langkah berikut untuk instalasi yang berhasil:

Klon The Repository: Mulailah dengan mengkloning repositori ke mesin lokal Anda.
```
 https://github.com/ShaanCoding/makeread.me
```
Instal Paket Frontend: Navigasikan ke direktori "/frontend" dan instal paket benang yang diperlukan dengan menjalankan perintah berikut di terminal Anda:
```
yarn install
```
Instal Paket Backend: Demikian pula, navigasikan ke direktori "/backend" dan instal paket benang yang diperlukan dengan menjalankan perintah berikut di terminal Anda:
```
yarn install
```
Mengatur lingkungan:
- Di direktori "/backend", salin konten file ".env.example" dan buat file baru bernama ".env". Sesuaikan variabel lingkungan sesuai dengan kebutuhan Anda atau Anda dapat membiarkannya.
- Arahkan ke "Frontend/API/Generated/ReadMegenerator.ts" dan atur parameter dasar ke rute API backend Anda. Misalnya, jika Anda menjalankan backend di server lokal Anda di port 8080, Anda harus mengatur:
```
BASE: "http://localhost:8080/api" ;
```
Jalankan backend: Navigasikan ke direktori "/backend" dan ketik perintah berikut di terminal Anda untuk menjalankan server backend Anda:
```
yarn dev
```
Jalankan Frontend: Terakhir, navigasikan ke direktori "/frontend" dan ketik perintah berikut di terminal Anda untuk menjalankan server frontend Anda:
```
yarn dev
```
Sekarang, aplikasi Anda harus berhasil dan berjalan!

Peta jalan

Roadmap mencakup tujuan yang lengkap dan di masa depan. Inilah yang telah kami capai dan nantikan:

Kami melanjutkan komitmen kami untuk meningkatkan dan memperluas kemampuan MakeRead.me untuk memberikan pengalaman pembuatan readme yang efisien dan mulus kepada pengguna kami.

Lihat masalah terbuka untuk daftar lengkap fitur yang diusulkan (dan masalah yang diketahui).

Berkontribusi

Kontribusi inilah yang membuat komunitas open source menjadi tempat yang luar biasa untuk belajar, menginspirasi, dan menciptakan. Kontribusi apa pun yang Anda buat sangat dihargai .

Jika Anda memiliki saran yang akan membuat ini lebih baik, silakan garukan repo dan buat permintaan tarik. Anda juga bisa membuka masalah dengan tag "peningkatan". Jangan lupa memberi proyek bintang! Terima kasih lagi!