civitai

Índice

• Sobre o projeto
  • Pilha de tecnologia
• Começando
  • Pré -requisitos
  • Instalação
  • Scripts importantes
• Contribuindo
• Patrocinadores
• Licença

Sobre o projeto

Nosso objetivo com este projeto é criar uma plataforma em que as pessoas possam compartilhar seus modelos de difusão estável (inversões textuais, hipernets, gradientes estéticos, vaes e qualquer outra coisa louca que as pessoas fazem para personalizar suas gerações de IA), colaborar com outras pessoas para melhorá -las, e aprender com o trabalho um do outro. A plataforma permite que os usuários criem uma conta, enviem seus modelos e navegam modelos que foram compartilhados por outras pessoas. Os usuários também podem deixar comentários e feedback sobre os modelos um do outro para facilitar a colaboração e o compartilhamento de conhecimento.

Pilha de tecnologia

Construímos este projeto usando uma combinação de tecnologias modernas da Web, incluindo o Next.js para o front -end, TRPC para a API e PRISMA + Postgres para o banco de dados. Ao aproveitar essas ferramentas, conseguimos criar uma plataforma escalável e sustentável que seja amigável e poderosa.

• DB: PRISMA + PostGres
• API: TRPC
• Front-end + back-end: NextJs
• Kit da interface do usuário: Mantino
• Armazenamento: Cloudflare

Começando

Para obter uma cópia local em funcionamento, siga estas etapas simples de exemplo.

Pré -requisitos

Primeiro, verifique se você tem o seguinte instalado em sua máquina:

• Node.js (versão 18 ou mais tarde)
• Docker (para executar o banco de dados)

Recomendamos que você tenha instalado nvm para definir a versão do nó correto para executar este projeto

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

Instalação

1. Clone o repositório da sua máquina local.
2. Execute npm install no diretório do projeto para instalar as dependências necessárias.
3. Spin Up Notom Services com docker-compose up -d
   • NOTA: Além do Postgres e Redis, isso também executará o MailDev por e -mail e Minio para armazenamento S3 com todos os baldes necessários criados automaticamente, Minio e MailDev não são estritamente necessários, mas são preferidos para fins de teste e desenvolvimento.
4. Crie seu .env fazendo uma cópia do conteúdo do arquivo .env-example .
   • A maioria dos valores padrão é configurada para trabalhar com a configuração do Docker-Compose, com exceção da chave de upload e segredo do S3. Para gerá -los, navegue até a interface da Web Minio em http: // localhost: 9000 com o nome de usuário padrão e minioadmin e navegue até a guia "Chaves de acesso". Clique em "Criar chave de acesso" e copie a chave gerada e o segredo no arquivo .env .
   • Defina WEBHOOK_TOKEN para uma string aleatória de sua escolha. Isso será usado para autenticar solicitações no endpoint webhook.
   • Comentar ou remover
     • CLICKHOUSE_HOST
     • CLICKHOUSE_USERNAME
     • CLICKHOUSE_PASSWORD
     • CLICKHOUSE_TRACKER_URL
   • Adicione uma sequência aleatória de sua escolha às propriedades de email para permitir o registro do usuário
     • EMAIL_USER
     • EMAIL_PASS
     • EMAIL_FROM (formato de email válido necessário)
   • Substitua ORCHESTRATOR_ENDPOINT URL por http: // localhost
   • Defina NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY como uma string aleatória de sua escolha. Isso funciona como um desvio como credenciais de faixa são internas
   • Adicione http: // localhost como o valor aos seguintes campos
     • RESOURCE_RECOMMENDER_URL
     • NOTIFICATION_DB_URL
     • NOTIFICATION_DB_REPLICA_URL
5. Execute npm run db:migrate para executar todas as migrações de banco de dados.
6. Execute npm run db:generate para gerar o cliente PRISMA.
7. Inicie o servidor de desenvolvimento executando npm run dev .
8. Visite a página http://localhost:3000/api/webhooks/run-jobs?token=WEBHOOK_TOKEN&run=update-metrics para iniciar o trabalho de atualização das métricas (certifique-se de substituir WEBHOOK_TOKEN )
9. Finalmente, visite http: // localhost: 3000 para ver o site.
   • Observe que a criação da conta executará e -mails através do MailDev, que podem ser acessados ​​em http: // localhost: 1080.
   • Observe também que as credenciais do CloudFlare são necessárias para que o upload de imagens funcione.

Scripts 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 

Contribuindo

Quaisquer contribuições que você faz são muito apreciadas .

Se você tiver uma sugestão que melhoraria isso, bifór -l e crie uma solicitação de tração. Você também pode simplesmente abrir um problema com a tag "aprimoramento". Não se esqueça de dar uma estrela ao projeto! Obrigado novamente!

1. Fork o repositório para sua própria conta do GitHub.
2. Crie uma nova filial para suas alterações.
3. Faça suas alterações no código.
4. Compreenda suas mudanças e empurre o ramo para o repositório bifurcado.
5. Abra uma solicitação de tração em nosso repositório.

Se você gostaria de estar mais envolvido, considere ingressar na equipe de desenvolvimento da comunidade ! Para obter mais informações sobre a equipe e como ingressar, consulte Calling All Developers: junte -se à equipe de desenvolvimento comunitário da Civitai.

Patrocinadores

Apoie este projeto, tornando -se um patrocinador. Seu logotipo aparecerá aqui com um link para o seu site.

Licença

Apache License 2.0 - Dê uma olhada na licença para obter mais detalhes.