tik-tech

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

★ 62 Open GitHub ↗

Is a video generator for explain specific framework or lib.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Tik Tech

O Tik Tech é um aplicativo gerador de vídeos que explica frameworks e bibliotecas de Node.js e Python. Ele automatiza a criação de vídeos explicativos sobre como utilizar diferentes frameworks e bibliotecas, gerando código de exemplo, narrando os passos e juntando tudo em um vídeo. Este documento fornecerá um guia passo a passo sobre como configurar e usar o Tik Tech.

**Utilizando o app**

https://github.com/viniciussantos45/tik-tech/assets/47752947/aa6c95d4-7a2c-40f3-a7fb-fc112fff9212

## Tecnologias Utilizadas

- [Puppeteer](https://pptr.dev/): Para gerar a capa do vídeo e o código do exemplo de uso da feature.
- [AWS Polly](https://aws.amazon.com/polly/): Para gerar a narração do vídeo.
- [OpenAI API](https://beta.openai.com/): Para gerar o código, a narração e detalhes da capa do vídeo.
- [FFmpeg](https://www.ffmpeg.org/): Para juntar todas as partes do vídeo.
- [Express.js](https://expressjs.com/): Para criar as rotas da API.
- [Vite](https://vitejs.dev/), [Shadcn](https://shadcn.github.io/), [Tailwind CSS](https://tailwindcss.com/), e [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API): Para desenvolver o frontend.
- [Socket.io](https://socket.io/): Para comunicar entre o frontend e o backend durante as etapas de geração do vídeo.
- [Docker](https://www.docker.com/): Para containerizar a aplicação.

## Configuração

### Variáveis de Ambiente

Crie um arquivo chamado `.env` no diretório raiz do projeto, usando o seguinte formato baseado no `.env.example` fornecido:

```env
OPENAI_API_KEY=your_openai_api_key 
PATH_RESULTS="results" 
AWS_REGION="us-east-1" 
AWS_ACCESS_KEY_ID=your_aws_access_key_id 
AWS_SECRET_ACCESS_KEY=your_aws_secret_access_key
```

### Dockerfile

O `Dockerfile` incluído no projeto define o ambiente necessário para executar o Tik Tech. Ele começa com uma imagem base do Node.js, instala o FFmpeg, copia o código fonte do projeto para a imagem e constrói o frontend e a API antes de expor a porta 10000 para comunicação.

### Docker Compose

O `docker-compose.yml` define como os serviços do Tik Tech são orquestrados. Inclui três serviços: `api`, `image-generator`, e `carbonara`. O serviço `api` constrói o contexto atual, expõe as portas necessárias, e define as dependências necessárias. Os serviços `image-generator` e `carbonara` são configurados de maneira semelhante, com o `image-generator` construindo a partir de um subdiretório do projeto.

## Executando o Tik Tech

1. Certifique-se de que o Docker e o Docker Compose estão instalados em sua máquina.
2. Navegue até o diretório raiz do projeto no terminal.
3. Execute o comando `docker-compose up --build -d` para construir e iniciar todos os serviços definidos no `docker-compose.yml`.
4. Uma vez que todos os serviços estejam em execução, acesse `http://localhost:10000` em seu navegador para acessar a interface do usuário do Tik Tech.
5. Use a interface do usuário para gerar vídeos, especificando a feature e a linguagem de programação desejada.

## Rotas da API

- **POST** `/api/generate`: Gera um vídeo com base nos parâmetros fornecidos no corpo da requisição.
  - Corpo da requisição: `{ "feature": "nome_da_feature", "programming_language": "linguagem_de_programação" }`
- **GET** `/api/download/:id`: Baixa o vídeo gerado, onde `:id` é o UUID do vídeo gerado.
- **GET** `/`: Serve o cliente frontend.

## Desenvolvimento Frontend

O frontend do Tik Tech foi desenvolvido usando Vite, Shadcn, Tailwind CSS, e IndexedDB. Você pode encontrar os arquivos de origem no diretório `client/front-end`. Para desenvolver localmente, navegue até este diretório e execute `yarn` para instalar as dependências e `yarn dev` para iniciar o servidor de desenvolvimento.

tik-tech

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README