README.md

Aplicação construída no NLW AI da Rocketseat na trilha Mastery.

Sobre o Projeto   |    Tecnologias e ferramentas   |    Instalação e utilização   |    Licença

🗒️ Sobre o projeto

Desenvolvida na trilha Mastery na edição NLW IA da Rocketseat, a aplicação upload.ai permite ao usuário fazer o upload de um vídeo e, por meio da API da OpenAI, criar automaticamente títulos chamativos e descrições com um boa indexação com base no prompt personalizado.

🛠️ Tecnologias e ferrementas utilizadas

Back end (api)

• TypeScript
• Node.js
• Fastify
• Prisma
• Zod
• SQLite
• OpenAi
• Vercel AI SDK

Front end (web):

• TypeScript
• React
• Vite
• TailwindCSS
• Axios
• Radix UI
• Shadcn/ui
• Lucide React
• FFmpeg
• Vercel AI SDK

💻 Instalação e utilização

Para executar a aplicação em sua máquina localmente, certifique-se de ter o Node.js e um gerenciador de pacotes instalados antes de prosseguir com as etapas abaixo:

Nesse projeto foi utilizado o pnpm como gerenciador de pacotes, que busca economizar espaço em disco e acelerar a instalação de pacotes devido à sua abordagem de armazenamento de dependências compartilhado.

Passo 1: Clone este repositório

$ git clone https://github.com/welisonw/nlw13_2023-mastery-upload-ai.git

Back end (api)

Passo 1: Acesse a pasta do projeto

$ cd nlw13_2023-mastery-upload-ai/api

Passo 2: Instale as dependências

# pnpm 
$ pnpm install

# npm
$ npm install

# yarn
$ yarn install

Passo 3: Crie o arquivo .env com as variáveis de ambiente necessárias:

DATABASE_URL="file:./dev.db"
OPENAI_KEY=*sua OpenAI key*

⚠️ Importante: No campo DATABASE_URL, especifique a URL do banco de dados que deseja utilizar. Crie uma conta no site OpenAI, obtenha sua chave da API e preencha-o no campo OPENAI_KEY.

Passo 4: Gere o client do Prisma

# pnpm
pnpm prisma generate

# npm
npm prisma generate

# yarn
yarn prisma generate

Passo 5: Execute as migrations do banco de dados:

# pnpm
pnpm prisma migrate dev

# npm
npm prisma migrate dev

# yarn
yarn prisma migrate dev

Passo 6: Inicie o projeto

# pnpm
pnpm run dev

# npm
npm run dev

# yarn
yarn run dev

O servidor estará disponível em http://localhost:3333.

Front end (web)

Passo 1: Acesse a pasta do projeto

$ cd nlw13_2023-mastery-upload-ai/web

Passo 2: Instale as dependências

# pnpm 
$ pnpm install

# npm
$ npm install

# yarn
$ yarn install

Passo 3: Inicie o projeto

# pnpm
pnpm run dev

# npm
npm run dev

# yarn
yarn run dev

A aplicação estará disponível em http://localhost:5173.

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.