codu

Codú

Ruang untuk Coders

Codú adalah komunitas utama pengembang web untuk belajar, berbagi, dan mendapatkan dukungan untuk proyek Anda, baik besar atau kecil. Ini adalah tempat yang sempurna untuk mempertajam keterampilan Anda dan membangun portofolio Anda. Di Codú, kita semua di sini untuk saling membantu tumbuh sebagai pengembang web. Plus, Codú memudahkan untuk menemukan kolaborator untuk proyek besar Anda berikutnya.

---

Bergabunglah dengan percakapan

Kami memiliki komunitas yang fantastis yang tumbuh di perselisihan. Klik di sini untuk bergabung!

---

Instalasi

1. Garpu proyek
2. Klon dengan git clone https://github.com/YOUR_USERNAME/codu.git .
3. Arahkan ke Direktori Proyek cd codu .
4. Instal dependensi dengan:

npm install

• Jika Anda memiliki masalah menginstal dependensi, periksa versi node Anda terhadap yang ditentukan dalam .nvmrc . Jika Anda menggunakan nvm , Anda dapat menjalankan nvm use sebelum memasang dependensi.

5. Buat file .env dan tambahkan variabel berikut. Anda dapat menyalin konten sample.env dengan cat sample.env > .env .

 # This default value is if you run our local docker-compose.yml file to create the database.
DATABASE_URL=postgresql://postgres:[email protected]:5432/postgres
# Setup your GitHub ID & Secret on GitHub: https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps
# For development, make sure you set up this with a Homepage URL of http://localhost:3000/ and an Authorization callback URL of http://localhost:3000/api/auth
GITHUB_ID=YOUR_GITHUB_APP_ID
GITHUB_SECRET=YOUR_GITHUB_APP_SECRET
NEXTAUTH_URL=http://localhost:3000/api/auth

Untuk panduan yang lebih rinci tentang pengaturannya, Pergi ke bagian Variabel Lingkungan.

Catatan: Sebelum melanjutkan, pastikan database Anda berjalan.

6. Siapkan tabel dalam database dengan gerimis dengan menjalankan:

npm run db:migrate

Perintah lengkap dapat dilihat di file package.json kami.

7. Seed the Database dengan beberapa data tiruan dengan menjalankan:

npm run db:seed

Perintah lengkap dapat dilihat di file package.json kami.

8. Akhirnya, jalankan server pengembangan:

npm run dev

Setelah menyelesaikan perintah di atas, navigasikan ke http: // localhost: 3000 di browser Anda untuk melihat hasilnya.

Anda dapat memulai perjalanan dengan memodifikasi pages/index.tsx . Dengan fitur pembaruan otomatis, pembaruan halaman saat Anda mengedit file.

Direktori pages/api dipetakan ke /api/* . File dalam direktori ini diperlakukan sebagai rute API alih -alih halaman bereaksi.

Pelajari lebih lanjut tentang rute API di sini.

Variabel Lingkungan

Database_url

DATABASE_URL adalah string koneksi ke database PostgreSQL (versi 15.0).

Secara default, kami menunjuk ke database yang berjalan secara lokal dengan Docker dari file docker-compose.yml kami.

Untuk menjalankan file ini, pastikan Anda telah menginstal Docker dan Docker sedang berjalan.

Jalankan perintah docker compose up .

Atau, jika Anda memiliki PostgreSQL berjalan secara lokal, Anda dapat menggunakan string koneksi lokal atau mengambil satu dari layanan gratis seperti Supabase.

Github_id dan github_secret

Saat ini, kami hanya mengizinkan otentikasi melalui GitHub. Untuk mengaktifkan ini, Anda harus memiliki nilai GITHUB_ID dan GITHUB_SECRET .

Siapkan ID & Rahasia GitHub Anda di GitHub:

• Klik di sini untuk mengatur aplikasi OAuth baru dan isi detail seperti yang ditunjukkan di bawah ini.

Untuk pengembangan, pastikan Anda mengatur ini dengan URL beranda

 http://localhost:3000/

dan URL panggilan balik otorisasi

 http://localhost:3000/api/auth

Setelah Anda mengklik tombol "Daftar Aplikasi", Anda akan melihat GITHUB_ID dan dapat menghasilkan rahasia klien baru. Setelah menghasilkan rahasia, pastikan Anda menyalin nilai ini ke file .env Anda karena nilai ini tidak dapat dilihat lagi setelah Anda menyegarkan halaman.

Info lebih lanjut tentang mengesahkan OAuth dalam dokumentasi GitHub di sini.

Menyiapkan Auth Tanpa Kata Sandi secara lokal

Untuk menggunakan login tanpa kata sandi secara lokal, Anda harus memiliki nilai ACCESS_KEY dan SECRET_KEY .

Lihat contoh file .env di sini untuk melihat cara mengisi nilai -nilai ini.

Catatan: Saat ini, wilayah AWS dari layanan SNS hardcoded untuk "UE-West-1"; Mungkin perlu mengubah ini jika layanan SNS Anda berada di wilayah yang berbeda.

NextAuth_Url

Anda tidak perlu mengubah nilai default di sini. Ini adalah variabel yang digunakan oleh auth berikutnya sebagai URL otentikasi ke situs Anda.

 NEXTAUTH_URL=http://localhost:3000/api/auth

Contoh file .env dapat ditemukan di sini. Anda dapat mengganti nama ini menjadi .env untuk memulai.

? ‍ Pedoman Kontribusi

• Kontribusi sangat dihargai . Kontribusi menjadikan komunitas open-source tempat yang luar biasa untuk belajar, menginspirasi, dan menciptakan.
• Lihatlah pedoman kontribusi kami untuk berkontribusi pada repo kami. Itu termasuk
  • Bagaimana berkontribusi
  • Cara membuat permintaan tarik
  • Jalankan tes
  • Panduan Gaya untuk Pesan Komit

? Keterampilan prasyarat untuk berkontribusi

• Git

? Kontribusi dokumentasi

• Penurunan harga

? Kontribusi Kode

• Bereaksi
• Next.js
• PostgreSQL
• Tailwind
• Gerimis

Sumber daya tambahan

Untuk mempelajari lebih lanjut tentang Next.js, lihatlah sumber daya berikut:

• Dokumentasi Next.js - Pelajari Tentang Fitur dan API Next.js.
• Pelajari Next.js - Tutorial interaktif Next.js.

Editor Doc

Untuk mempelajari tentang pintasan editor dan hotkey, Anda dapat memeriksa dokumen ini:

• Markdoc Editor Hotkeys and Shortcuts

? Pengujian E2E

Untuk informasi tentang pengujian E2E, silakan merujuk ke dokumentasi khusus kami di sini.

? Masalah

Anda dipersilakan untuk membuka masalah untuk membahas ide -ide tentang peningkatan Codú. Peningkatan didorong dan dihargai.