civitai

Tabla de contenido

• Sobre el proyecto
  • Pila de tecnología
• Empezando
  • Requisitos previos
  • Instalación
  • Guiones importantes
• Que contribuye
• Patrocinadores
• Licencia

Sobre el proyecto

Nuestro objetivo con este proyecto es crear una plataforma donde las personas puedan compartir sus modelos de difusión estables (inversiones textuales, Hypernetworks, gradientes estéticos, VAE y cualquier otra cosa loca que la gente haga para personalizar sus generaciones de IA), colabore con otros para mejorarlos, y aprender del trabajo del otro. La plataforma permite a los usuarios crear una cuenta, cargar sus modelos y explorar modelos que han sido compartidos por otros. Los usuarios también pueden dejar comentarios y comentarios sobre los modelos de los demás para facilitar la colaboración y el intercambio de conocimientos.

Pila de tecnología

Hemos creado este proyecto utilizando una combinación de tecnologías web modernas, que incluyen Next.js para Frontend, TRPC para la API y PRISMA + Postgres para la base de datos. Al aprovechar estas herramientas, hemos podido crear una plataforma escalable y mantenible que sea fácil de usar y potente.

• DB: Prisma + Postgres
• API: TRPC
• Front-end + back-end: nextjs
• Kit de interfaz de usuario: Mantine
• Almacenamiento: Cloudflare

Empezando

Para obtener una copia local y en ejecución, siga estos simples pasos de ejemplo.

Requisitos previos

Primero, asegúrese de tener lo siguiente instalado en su máquina:

• Node.js (versión 18 o posterior)
• Docker (por ejecutar la base de datos)

Le recomendamos que haya instalado nvm para establecer la versión de nodo correcta para ejecutar este proyecto

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

Instalación

1. Clonar el repositorio de su máquina local.
2. Ejecute npm install en el directorio del proyecto para instalar las dependencias necesarias.
3. Surgir los servicios requeridos con docker-compose up -d
   • Nota: Además de Postgres y Redis, esto también ejecutará Maildev para el correo electrónico y Minio para el almacenamiento S3 con todos los cubos necesarios creados automáticamente, Minio y Maildev no se necesitan estrictamente, pero se prefieren para fines de pruebas y desarrollo.
4. Cree su .env haciendo una copia del contenido del archivo .env-example .
   • La mayoría de los valores predeterminados están configurados para funcionar con la configuración de Docker-Compose, con la excepción de la clave de carga y secreto de S3. Para generarlos, navegue a la interfaz web Minio en http: // localhost: 9000 con el nombre de usuario y contraseña predeterminados minioadmin , y luego navegue a la pestaña "Cayas de acceso". Haga clic en "Crear clave de acceso" y copie la tecla generada y secreta en el archivo .env .
   • Establezca WEBHOOK_TOKEN en una cadena aleatoria de su elección. Esto se utilizará para autenticar las solicitudes en el punto final de Webhook.
   • Comentar o eliminar
     • CLICKHOUSE_HOST
     • CLICKHOUSE_USERNAME
     • CLICKHOUSE_PASSWORD
     • CLICKHOUSE_TRACKER_URL
   • Agregue una cadena aleatoria de su elección a las propiedades de correo electrónico para permitir el registro del usuario
     • EMAIL_USER
     • EMAIL_PASS
     • EMAIL_FROM (se necesita formato de correo electrónico válido)
   • Reemplace la URL ORCHESTRATOR_ENDPOINT con http: // localhost
   • Establezca NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY en una cadena aleatoria de su elección. Esto funciona como un bypass ya que las credenciales de rayas son internas
   • Agregar http: // localhost como el valor a los siguientes campos
     • RESOURCE_RECOMMENDER_URL
     • NOTIFICATION_DB_URL
     • NOTIFICATION_DB_REPLICA_URL
5. Ejecutar npm run db:migrate para ejecutar todas las migraciones de bases de datos.
6. Ejecute npm run db:generate para generar el cliente PRISMA.
7. Inicie el servidor de desarrollo ejecutando npm run dev .
8. Visite la página http://localhost:3000/api/webhooks/run-jobs?token=WEBHOOK_TOKEN&run=update-metrics para iniciar el trabajo de actualización de métricas (asegúrese de sustituir WEBHOOK_TOKEN )
9. Finalmente, visite http: // localhost: 3000 para ver el sitio web.
   • Tenga en cuenta que la creación de cuentas ejecutará correos electrónicos a través de Maildev, a los que se puede acceder en http: // localhost: 1080.
   • También tenga en cuenta que las credenciales de CloudFlare son necesarias para que funcionen las cargas de imágenes.

Guiones importantes

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 

Que contribuye

Cualquier contribución que haga es muy apreciada .

Si tiene una sugerencia que lo mejore, desembolse el repositorio y cree una solicitud de extracción. También puede simplemente abrir un problema con la etiqueta "Mejora". ¡No olvides darle una estrella al proyecto! ¡Gracias de nuevo!

1. Bifurca el repositorio a su propia cuenta de GitHub.
2. Cree una nueva rama para sus cambios.
3. Haga sus cambios en el código.
4. Comprometer sus cambios y empuje la rama a su repositorio bifurcado.
5. Abra una solicitud de extracción en nuestro repositorio.

Si desea participar más, ¡considere unirse al equipo de desarrollo comunitario ! Para obtener más información sobre el equipo y cómo unirse, consulte Llamar a todos los desarrolladores: unirse al equipo de desarrollo comunitario de Civitai.

Patrocinadores

Apoye este proyecto al convertirse en patrocinador. Su logotipo aparecerá aquí con un enlace a su sitio web.

Licencia

Apache License 2.0 - Eche un vistazo a la licencia para obtener más detalles.