makeread.me

makeread.me

¡Un increíble generador de lectura para impulsar sus proyectos!

Explore los documentos »

Ver demostración. Informe de error. Solicitar la función

Tabla de contenido

• Tabla de contenido
• Sobre el proyecto
  • Construido con
• Empezando
  • Requisitos previos
  • Instalación
• Hoja de ruta
• Que contribuye
• Licencia
• Contacto
• Expresiones de gratitud
• Aviso

Sobre el proyecto

Uno de los desafíos con la construcción y la contribución al software de código abierto es que, si bien muchos proyectos tienen funcionalidades increíbles, a menudo se pierden llegar a un público más amplio debido a la falta de instrucciones de instalación claras y fáciles de usar. Además, la falta de escaparate eficiente de sus casos de uso también contribuye al menor alcance de estos proyectos.

Si bien hay plantillas de lectura que pueden ayudar a abordar esto, el proceso de completar manualmente estas plantillas puede llevar mucho tiempo y tedioso. Ahí es donde entra nuestro proyecto Makeread.me.

Introducción a Makeread.me, un generador de lectura automatizado que puede revolucionar cómo crea la documentación de su proyecto. Está diseñado para:

• Ahorre su valioso tiempo mejorando su enfoque en el desarrollo,
• Automatizar tareas redundantes y,
• Implemente principios secos (no se repita) a su documentación.

Es gratis, de código abierto y altamente personalizable. Siéntase libre de modificar nuestras plantillas para satisfacer sus necesidades. Si encuentra que falta un componente en particular, es más que bienvenido para contribuir y expandir el proyecto.

Le hemos facilitado contribuir al proyecto mediante el uso de plantillas Nunjucks y JSON para el mapeo programático. Disfrute de los beneficios de la documentación del proyecto clara y concisa con Makeread.me!

Construido con

Este proyecto fue construido con las siguientes tecnologías:

• Next.js
• Reaccionar
• Shadcn/ui
• Forma de gancho reaccionar
• Mecanografiado
• Expresar

Empezando

Este es un ejemplo de cómo puede dar instrucciones para configurar su proyecto localmente. Para obtener una copia local y en ejecución, siga estos simples pasos de ejemplo.

Requisitos previos

Este proyecto requiere que se instale el hilo en su sistema. Si no lo tiene instalado, puede seguir estos pasos:

• Instale el hilo globalmente con NPM (administrador de paquetes de nodo). Abra su terminal y ejecute:

  npm install -g yarn

  Asegúrese de tener Node.js y NPM instalados antes de ejecutar hilo.

• Verifique que el hilo se haya instalado en su máquina ejecutando el siguiente comando en su terminal:

  yarn --version

  Si el hilo se ha instalado correctamente, su terminal debe mostrar la versión de hilo instalada en su máquina.

¡Ahora está listo para usar el hilo para administrar y versiones de versiones de su proyecto!

Instalación

Siga los siguientes pasos para una instalación exitosa:

1. Clone El repositorio: comience clonando el repositorio a su máquina local.

    https://github.com/ShaanCoding/makeread.me
   

2. Instale paquetes frontend: navegue al directorio "/frontend" e instale los paquetes de hilo requeridos ejecutando el siguiente comando en su terminal:

   yarn install

3. Instale paquetes de backend: de manera similar, navegue al directorio "/backend" e instale los paquetes de hilo requeridos ejecutando el siguiente comando en su terminal:

   yarn install

4. Entorno de configuración:

   • En el directorio "/backend", copie el contenido del archivo ".env.example" y cree un nuevo archivo llamado "env ". Ajuste las variables de entorno de acuerdo con sus requisitos o puede dejarlas como está.

   • Navegue a "Frontend/API/Generated/ReadMegenerator.ts" y establezca el parámetro base en su ruta API de backend. Por ejemplo, si está ejecutando un backend en su servidor local en el puerto 8080, debe configurar:

     BASE: "http://localhost:8080/api" ;

5. Ejecute el directorio de backend: navegue al directorio "/backend" y escriba el siguiente comando en su terminal para ejecutar su servidor de backend:

   yarn dev

6. Ejecute el directorio frontend: finalmente, navegue al directorio "/frontend" y escriba el siguiente comando en su terminal para ejecutar su servidor frontend:

   yarn dev

   ¡Ahora, su aplicación debe estar en funcionamiento con éxito!

Hoja de ruta

La hoja de ruta incluye objetivos completos y futuros. Esto es lo que hemos logrado y esperando:

• Agregar generación de baggers de backend
• Agregar backend
• Configurar CI/CD en el ferrocarril
• Permitir la generación de campo de entrada dinámica basada en un archivo JSON
  • Textea
  • Aporte
  • Objetos
  • Formación
• Permitir a los usuarios establecer el orden de los componentes o eliminarlos
• Permitir plantillas a través de Nunjucks
• Agregar análisis plausible
• Agregue la plantilla de generador de readme antigua
• Agregar más plantillas
• Mover la lógica de representación al backend con el debilidad
• Reemplace UseeFectect con reacción consulta
• Agregar almacenamiento en caché
• Escribir artículos de mejor práctica Readme
• Evite las colisiones clave cuando se use nombres no únicos como IDS en plantillas

Continuamos nuestro compromiso de mejorar y expandir las capacidades de Makeread.me para proporcionar una experiencia de generación de lectura eficiente y perfecta a nuestros usuarios.

Consulte los problemas abiertos para una lista completa de características propuestas (y problemas conocidos).

Que contribuye

Las contribuciones son las que hacen que la comunidad de código abierto sea un lugar tan increíble para aprender, inspirar y crear. Cualquier contribución que haga es muy apreciada .

Si tiene una sugerencia que lo mejore, desembolse el repositorio y cree una solicitud de extracción. También puede simplemente abrir un problema con la etiqueta "Mejora". ¡No olvides darle una estrella al proyecto! ¡Gracias de nuevo!

1. Bifurca el proyecto
2. Cree su rama de características ( git checkout -b feature/AmazingFeature )
3. Comprometer sus cambios ( git commit -m 'Add some AmazingFeature' )
4. Push to the Branch ( git push origin feature/AmazingFeature )
5. Abra una solicitud de extracción

Licencia

Distribuido bajo la licencia de Licencia Pública de Mozilla 2.0. Consulte la licencia de Licencia Pública de Mozilla 2.0 para obtener más información.

Contacto

Si tiene alguna pregunta o sugerencia, no dude en comunicarse con nosotros:

• Plantear un problema en el repositorio: repositorio de GitHub
• Conéctese con nosotros en Twitter: @Shaancoding

Expresiones de gratitud

Un agradecimiento especial al siguiente por sus contribuciones, apoyo e inspiración:

• makeread.me
• Othneil Drew

Aviso

Este readme se generó usando makeread.me