ReadMeAI

? Readmeai?

Descripción general

El generador ReadMe es una plataforma que permite a los usuarios cargar un código de archivo único y describir su proyecto. La IA genera un código Markdown, que se puede editar en tiempo real utilizando un editor de código, y los cambios se observan al instante.

ReadMeai ahora está en vivo en ReadMeai.live

Navegación

• ? Readmeai?
  • Descripción general
  • Navegación
  • ? Características
  • Estructura de archivo (MVC)
  • Pila de tecnología
  • Instalación
    • En tu máquina local
    • En su máquina virtual (usando Docker)
  • Uso
    • En tu máquina local
    • Usando Docker Container
  • ? Características para el próximo lanzamiento.
  • ?Apoyo
  • ✍️ Autores

? Características

• Contenido con AI : utiliza Google AI para generar contenido significativo e informativo para su lectura, incluida la descripción del proyecto, el uso, la instalación y más.

• Personalización : puede personalizar el contenido generado utilizando un editor incorporado para incluir o excluir secciones específicas, asegurando que su lectura refleje las necesidades únicas de su proyecto.

• Soporte de Markdown : los archivos ReadMe generados usan Markdown, lo que facilita el formateo y el estilo de la documentación de su proyecto.

• Interfaz web fácil de usar : acceda al generador a través de una interfaz web fácil de usar, eliminando la necesidad de configuración manual.

Estructura de archivo (MVC)

• ? API/ : contiene un archivo de código para conectarse a la API de terceros (Google Palm 2)
• ? Controladores/ : Contiene toda la lógica comercial para ejecutar en solicitudes de publicación/ GET.
• ? Vistas/ : Contiene archivos para renderizar en los lados del cliente.
• ? Datos/ : contiene la 'plantilla' que contendrá la plantilla de salida y 'output.md' que emitirá Markdown.
• ? Public/ : Contiene CSS y scripts del lado del cliente.
• ? Rutas/ : archivo para manejar las rutas y llamar a la función del controlador respectivo en una ruta particular.
• ? Cargas/ : este directorio contendrá archivos que recibió ese servidor del lado del cliente y luego los elimina una vez que finalice la sesión.
• ? Server.js : este archivo es el servidor Express principal, este es el archivo que se ejecutará en el servidor inicial.
• ? DockerFile : este archivo contiene script para contenedorizar el proyecto.

Pila de tecnología

• Node.js: tiempo de ejecución del lado del servidor.
• Express: Node.js Framework.
• ? Google Palm API: Google Pathways Language Model es un modelo de lenguaje grande basado en transformadores de 540 mil millones de parámetros.
• ? EJS: Plantilla del motor para representar y agregar contenido dinámico en su HTML en el servidor.
• ? CSS: diseñando la plantilla HTML.
• JavaScript: para agregar interactividad en la interfaz.

Instalación

En tu máquina local

1. Clon el repositorio.
2. Navegue al directorio del proyecto.
3. Abra su terminal y ejecute:

    npm install

En su máquina virtual (usando Docker)

1. Clonar el repositorio y navegar al directorio del proyecto.
2. Abra el terminal y escriba el siguiente comando:

     docker build -t gitax18/readmeai . 

Uso

En tu máquina local

1. Cambiar al directorio del proyecto.
2. Abra su terminal y escriba el siguiente comando:

    npm start

3. La aplicación se ejecutará en http: // localhost: 3333

Usando Docker Container

1. Para iniciar el contenedor, escriba el siguiente comando:

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

2. Ahora la aplicación se ejecutará en http: // localhost: 3333

---

Nota: Si el proyecto no se ejecuta correctamente y muestra un error CRBUG en la consola web, siga los siguientes pasos.

1. Abra VScode y vaya al menú 'Ejecutar y depurar' en la barra lateral izquierda.
2. Haga clic en 'Crear un archivo Launch.json' y seleccione Node.js en el menú emergente.
3. Ahora haga clic en el icono de juego triangular verde en la misma barra lateral 'correr y depurar'.
4. Ahora vaya a http: // localhost: 3333

? Características para el próximo lanzamiento.

• Autorización de GitHub para agregar repose en lugar de un solo archivo.
• AI más entrenada para generar ReadMe para carpetas en lugar de archivo.
• Plantillas personalizadas, el usuario puede definir qué características/sección desea en su lectura.

?Apoyo

Si encuentra algún problema o tiene preguntas, no dude en crear un problema en el repositorio. ¡Estamos aquí para ayudar!

✍️ Autores

• Gitanshu Sankhla (desarrollador de backend) -

• Vijay Banjara (desarrollador frontend) -
  

• Harsh Kumar (diseñador) -