ReadMeAI ReadMeAI

ReadMeAI

Outro código-fonte

1.0.0

Baixar

? ReadMeii?

Visão geral

O gerador ReadMe é uma plataforma que permite que os usuários enviem um código de arquivo único e descreva seu projeto. A IA gera um código de marcação, que pode ser editado em tempo real usando um editor de código, e as alterações são visualizadas instantaneamente.

ReadMeii agora está ao vivo no ReadMeii.live

Navegação

? ReadMeii?
- Visão geral
- Navegação
- ? Características
- Estrutura de arquivo (MVC)
- Pilha de tecnologia
- Instalação
  - Na sua máquina local
  - Em sua máquina virtual (usando o Docker)
- Uso
  - Na sua máquina local
  - Usando o contêiner do docker
- ? Recursos para o próximo lançamento.
- ?Apoiar
- ✍️ Autores

? Características

Conteúdo movido a IA : ele usa o Google AI para gerar conteúdo significativo e informativo para o seu ReadMe, incluindo descrição do projeto, uso, instalação e muito mais.
Customização : você pode personalizar o conteúdo gerado usando um editor embutido para incluir ou excluir seções específicas, garantindo que o seu ReadMe reflita as necessidades exclusivas do seu projeto.
Suporte a marcação : Os arquivos de leitura gerados usam o Markdown, facilitando o formato e o estilo da documentação do seu projeto.
Interface da Web amigável : Acesse o gerador por meio de uma interface da Web fácil de usar, eliminando a necessidade de configuração manual.

Estrutura de arquivo (MVC)

? API/ : contém arquivo de código para conectar -se às APIs de terceiros (Google Palm 2)
? Controladores/ : contém toda a lógica de negócios para executar solicitações de postagem/ get.
? Views/ : Contém arquivos para renderizar nos lados do cliente.
? Dados/ : contém o 'modelo' que manterá o modelo de saída e 'saída.md' , que será lançado o markdown.
? Public/ : Contém CSS e scripts do lado do cliente.
? Rotas/ : Arquivo para lidar com rotas e chamar a respectiva função do controlador em uma rota específica.
? uploads/ : Este diretório manterá arquivos que o servidor recebeu do lado do cliente e os excluirá assim que a sessão terminar.
? Server.js : Este arquivo é o principal servidor expresso , este é o arquivo que será executado no servidor de partida.
? Dockerfile : Este arquivo contém script para o projeto de contêiner.

Pilha de tecnologia

Node.js: Tempo de execução do lado do servidor.
Express: Node.js Framework.
? API do Google Palm: o modelo de linguagem do Google Pathways é um modelo de grande linguagem baseado em parâmetros de parâmetros de 540 bilhões de parâmetros.
? EJS: Motor de modelos para renderizar e adicionar conteúdo dinâmico no seu HTML no servidor.
? CSS: modelando o modelo HTML.
JavaScript: para adicionar interatividade no front -end.

Instalação

Na sua máquina local

Clone o repositório.
Navegue até o diretório do projeto.
Abra seu terminal e corra:

    npm install

Em sua máquina virtual (usando o Docker)

Clone o repositório e navegue até o diretório do projeto.
Abra o terminal e digite o seguinte comando:

     docker build -t gitax18/readmeai .

Uso

Na sua máquina local

Mude no diretório do projeto.
Abra seu terminal e digite o seguinte comando:

    npm start

O aplicativo será executado em http: // localhost: 3333

Usando o contêiner do docker

Para iniciar o contêiner, digite o seguinte comando:

    docker run -it -p 3333:3333 gitax18/readmeai

Agora o aplicativo será executado em http: // localhost: 3333

Nota: Se o projeto não executar corretamente e mostrar erro de CRBUG no console da web, siga as seguintes etapas.

Abra o VSCODE e vá para o menu 'Run and Debug' na barra lateral esquerda.
Clique em 'Criar um arquivo de lançamento.json' e selecione Node.js no menu pop-up.
Agora clique no ícone Green Triangular Play no topo da mesma barra lateral 'Run and Debug'.
Agora vá para http: // localhost: 3333

? Recursos para o próximo lançamento.

Autorização do GitHub para adicionar repo em vez de um único arquivo.
AI mais treinada para gerar ReadMe para pastas do que o arquivo.
Modelos personalizados, o usuário pode definir quais recursos/seção eles desejam no seu ReadMe.