civitai

目錄

• 關於項目
  • 技術堆棧
• 入門
  • 先決條件
  • 安裝
  • 重要的腳本
• 貢獻
• 贊助商
• 執照

關於項目

我們在這個項目中的目標是創建一個平台，人們可以共享穩定的擴散模型（文本倒置，超網絡，美學梯度，VAE和人們為自定義AI世代的其他瘋狂事情），與他人合作以改進它們，以改善它們，並從彼此的工作中學習。該平台允許用戶創建一個帳戶，上傳他們的模型，並瀏覽其他人共享的模型。用戶還可以對彼此的模型發表評論和反饋，以促進協作和知識共享。

技術堆棧

我們已經使用現代Web技術的組合構建了該項目，包括for the Frontend的Next.js，API的TRPC和數據庫的Prisma + Postgres。通過利用這些工具，我們能夠創建一個既有用戶友好且功能強大的可擴展和可維護的平台。

• DB： Prisma + Postgres
• API： TRPC
• 前端 +後端： NextJS
• UI套件： Mantine
• 存儲： Cloudflare

入門

要獲得本地副本並運行，請按照以下簡單的示例步驟進行操作。

先決條件

首先，確保您的計算機上安裝了以下內容：

• Node.js（版本18或更高版本）
• Docker（用於運行數據庫）

我們建議您已經安裝了nvm ，以設置正確的節點版本以運行此項目

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

安裝

1. 將存儲庫克隆到您的本地計算機。
2. 在項目目錄中運行npm install以安裝必要的依賴項。
3. 用docker-compose up -d
   • 注意：除了Postgres和Redis外，這還將運行電子郵件和MINIO的S3存儲，並自動創建所有必要的存儲桶，Minio和MailDev並非嚴格需要，但首選用於測試和開發目的。
4. 通過從.env-example文件中製作內容的副本來創建.env 。
   • 大多數默認值都配置為與Docker-Compose設置一起使用，除了S3上傳密鑰和秘密外。要生成這些，請在http：// localhost：9000帶有默認用戶名和密碼minioadmin Minio Web界面，然後導航到“訪問鍵”選項卡。單擊“創建訪問密鑰”，然後將生成的密鑰和秘密複製到.env文件中。
   • 將WEBHOOK_TOKEN設置為您選擇的隨機字符串。這將用於對Webhook端點的請求進行身份驗證。
   • 評論或刪除
     • CLICKHOUSE_HOST
     • CLICKHOUSE_USERNAME
     • CLICKHOUSE_PASSWORD
     • CLICKHOUSE_TRACKER_URL
   • 在電子郵件屬性中添加您選擇的隨機字符串以允許用戶註冊
     • EMAIL_USER
     • EMAIL_PASS
     • EMAIL_FROM （需要有效的電子郵件格式）
   • 用http：// localhost替換ORCHESTRATOR_ENDPOINT URL
   • 將NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY設置為您選擇的隨機字符串。由於條紋憑據是內部的，因此該功能充當旁路
   • 將http：// localhost添加到以下字段中
     • RESOURCE_RECOMMENDER_URL
     • NOTIFICATION_DB_URL
     • NOTIFICATION_DB_REPLICA_URL
5. 運行npm run db:migrate以運行所有數據庫遷移。
6. 運行npm run db:generate以生成Prisma客戶端。
7. 通過運行npm run dev啟動開發服務器。
8. 訪問頁面http://localhost:3000/api/webhooks/run-jobs?token=WEBHOOK_TOKEN&run=update-metrics啟動指標更新作業（請確保替換WEBHOOK_TOKEN ）
9. 最後，訪問http：// localhost：3000查看網站。
   • 請注意，帳戶創建將通過MailDev運行電子郵件，該電子郵件可以通過http：// localhost：1080訪問。
   • 另請注意，為了使圖像上傳工作，CloudFlare憑據是必要的。

重要的腳本

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 

貢獻

您所做的任何貢獻都非常感謝。

如果您有一個可以使情況變得更好的建議，請分配存儲庫並創建拉動請求。您也可以簡單地使用標籤“增強”打開問題。別忘了給項目一個明星！再次感謝！

1. 將存儲庫分配給您自己的GitHub帳戶。
2. 為您的更改創建一個新的分支。
3. 對代碼進行更改。
4. 提交您的更改，並將分支推向您的分叉存儲庫。
5. 在我們的存儲庫上打開拉動請求。

如果您想更多地參與其中，請考慮加入社區發展團隊！有關團隊以及如何加入的更多信息，請參閱致電所有開發人員：加入Civitai的社區開發團隊。

贊助商

通過成為贊助商來支持這個項目。您的徽標將在此處顯示您網站的鏈接。

執照

Apache許可證2.0-請查看許可證以獲取更多詳細信息。