civitai

Daftar isi

• Tentang proyek
  • Tumpukan teknologi
• Memulai
  • Prasyarat
  • Instalasi
  • Skrip penting
• Berkontribusi
• Sponsor
• Lisensi

Tentang proyek

Tujuan kami dengan proyek ini adalah untuk membuat platform di mana orang dapat berbagi model difusi stabil mereka (inversi tekstual, Hypernetworks, gradien estetika, VAE, dan hal -hal gila lainnya yang dilakukan orang untuk menyesuaikan generasi AI mereka), berkolaborasi dengan orang lain untuk meningkatkannya, dan belajar dari pekerjaan masing -masing. Platform ini memungkinkan pengguna untuk membuat akun, mengunggah model mereka, dan menelusuri model yang telah dibagikan oleh orang lain. Pengguna juga dapat meninggalkan komentar dan umpan balik pada model masing -masing untuk memfasilitasi kolaborasi dan berbagi pengetahuan.

Tumpukan teknologi

Kami telah membangun proyek ini menggunakan kombinasi teknologi web modern, termasuk Next.js untuk frontend, TRPC untuk API, dan prisma + postgres untuk database. Dengan memanfaatkan alat-alat ini, kami telah dapat membuat platform yang dapat diskalakan dan dapat dipelihara yang ramah pengguna dan kuat.

• DB: Prisma + Postgres
• API: TRPC
• Front-end + back-end: nextjs
• UI Kit: Mantine
• Penyimpanan: Cloudflare

Memulai

Untuk mendapatkan salinan lokal dan berjalan ikuti langkah -langkah contoh sederhana ini.

Prasyarat

Pertama, pastikan bahwa Anda memiliki yang diinstal pada mesin Anda:

• Node.js (versi 18 atau lebih baru)
• Docker (untuk menjalankan database)

Kami sarankan Anda telah menginstal nvm untuk mengatur versi simpul yang tepat untuk menjalankan proyek ini

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | bash

Instalasi

1. Kloning repositori ke mesin lokal Anda.
2. Jalankan npm install di direktori proyek untuk menginstal dependensi yang diperlukan.
3. Spin up layanan yang diperlukan dengan docker-compose up -d
   • Catatan: Selain Postgres dan Redis, ini juga akan menjalankan MailDev untuk email dan minio untuk penyimpanan S3 dengan semua ember yang diperlukan secara otomatis dibuat, Minio dan Maildev tidak sepenuhnya dibutuhkan tetapi lebih disukai untuk tujuan pengujian dan pengembangan.
4. Buat .env Anda dengan membuat salinan konten dari file .env-example .
   • Sebagian besar nilai default dikonfigurasi untuk bekerja dengan pengaturan komposisi Docker, dengan pengecualian kunci unggahan S3 dan rahasia. Untuk menghasilkannya, arahkan ke antarmuka web minio di http: // localhost: 9000 dengan nama pengguna dan kata sandi minioadmin default, dan kemudian navigasikan ke tab "Akses Keys". Klik "Buat Kunci Akses" dan salin kunci yang dihasilkan dan rahasia ke dalam file .env .
   • Atur WEBHOOK_TOKEN ke string acak pilihan Anda. Ini akan digunakan untuk mengotentikasi permintaan ke titik akhir webhook.
   • Berkomentar atau hapus
     • CLICKHOUSE_HOST
     • CLICKHOUSE_USERNAME
     • CLICKHOUSE_PASSWORD
     • CLICKHOUSE_TRACKER_URL
   • Tambahkan string acak pilihan Anda ke properti email untuk memungkinkan pendaftaran pengguna
     • EMAIL_USER
     • EMAIL_PASS
     • EMAIL_FROM (format email yang valid diperlukan)
   • Ganti ORCHESTRATOR_ENDPOINT url dengan http: // localhost
   • Setel NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY ke string acak pilihan Anda. Ini berfungsi sebagai bypass sebagai kredensial strip adalah internal
   • Tambahkan http: // localhost sebagai nilai ke bidang berikut
     • RESOURCE_RECOMMENDER_URL
     • NOTIFICATION_DB_URL
     • NOTIFICATION_DB_REPLICA_URL
5. Jalankan npm run db:migrate untuk menjalankan semua migrasi basis data.
6. Jalankan npm run db:generate untuk menghasilkan klien PRISMA.
7. Mulai server pengembangan dengan menjalankan npm run dev .
8. Kunjungi halaman http://localhost:3000/api/webhooks/run-jobs?token=WEBHOOK_TOKEN&run=update-metrics untuk memulai pekerjaan pembaruan metrik (pastikan untuk menggantikan WEBHOOK_TOKEN )
9. Akhirnya, kunjungi http: // localhost: 3000 untuk melihat situs web.
   • Perhatikan bahwa pembuatan akun akan menjalankan email melalui MailDev, yang dapat diakses di http: // localhost: 1080.
   • Perhatikan juga bahwa kredensial cloudflare diperlukan agar unggahan gambar berfungsi.

Skrip penting

docker-compose up -d # Spin up db, redis, maildev, and minio

npm run dev # Start the dev environment

npm run db:migrate -- --name migration-name # Create a database migration with prisma after updating the schema

npm run db:generate # Generates local prisma client

npm run db:ui # Start Prisma Studio to manage the database content

npm run build # Build the NextJS project 

Berkontribusi

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!

1. Parut repositori ke akun github Anda sendiri.
2. Buat cabang baru untuk perubahan Anda.
3. Buat perubahan Anda pada kode.
4. Komit perubahan Anda dan dorong cabang ke repositori bercabang Anda.
5. Buka permintaan tarik di repositori kami.

Jika Anda ingin lebih terlibat, pertimbangkan untuk bergabung dengan tim pengembangan komunitas ! Untuk informasi lebih lanjut tentang tim serta cara bergabung, lihat panggilan semua pengembang: Bergabunglah dengan tim pengembangan komunitas Civitai.

Sponsor

Dukung proyek ini dengan menjadi sponsor. Logo Anda akan muncul di sini dengan tautan ke situs web Anda.

Lisensi

Lisensi Apache 2.0 - Silakan lihat lisensi untuk detail lebih lanjut.