? Descripción general
EasyReadMe es un proyecto que simplifica la creación de readMe al generar readmes visualmente impresionantes utilizando plantillas prediseñadas y IA. Admite la generación de readmes para proyectos JavaScript/TypeScript, Rust, Java, GO, PHP y Python. Se basa en una amplia gama de tecnologías y bibliotecas que incluyen React, Tailwind CSS, TIPTAP, OpenAI y más.
? Tabla de contenido
❤️ Características
Pila
Resumen del proyecto
Configuración
Ejecutar localmente
? ️ Hoja de ruta
Expresiones de gratitud
? Licencia
Características
introducción.mp4
Lista de plantillas
plantillas.mp4
Personalizar ReadMe
personalizar.mp4
Secciones de IA
ai-sections.mp4
Comandos en línea
comandos.mp4
Menú de burbujas
Bubble-Menu.mp4
URL de imagen de banner editable
Update-Banner.mp4
Créditos de IA gratuitos, tecla API personalizada, ejecución local
API-Offline-Generations.mp4
Pila
- SIGUIENTE: Un marco para construir aplicaciones React renderizadas por el servidor.
- React: una biblioteca JavaScript para construir interfaces de usuario.
- TypeScript: un superconjunto escrito de JavaScript que se compila en JavaScript simple.
- Shadcn/UI: proporciona componentes bellamente diseñados para la interfaz de usuario.
- Tailwindcss: un marco CSS de utilidad para el desarrollo rápido de la interfaz de usuario.
- Vaul: un componente de cajón no establecido para React.
- Sonner: Un componente de tostado obstinado para React.
- TipTap/Core: un marco de editor de texto rico altamente personalizable y extensible.
- SWR: Maneja la obtención de datos, el almacenamiento en caché y la sincronización con el servidor.
- Zustand: una biblioteca de gestión estatal pequeña, rápida y escalable.
- Lucide: íconos hermosos y consistentes.
Resumen del proyecto
- SRC : directorio de código fuente primario.
- SRC/APP : contiene la lógica y los componentes principales de la aplicación.
- SRC/Componentes : casas componentes de interfaz de usuario reutilizables.
- SRC/Hooks : ganchos reaccionados personalizados para gestionar los efectos estatales y secundarios.
- SRC/LIB : funciones de utilidad y módulos de ayuda.
- SRC/Servicios : módulos para interactuar con API externas.
- SRC/estilos : estilos globales y módulos CSS.
- SRC/Tipos : definiciones de tipos de mecanografiado.
- SRC/Utils : funciones de utilidad misceláneas.
- Público : Directorio público para activos estáticos y salida de compilación.
Configuración
OPERAI_API_KEY
- Vaya al sitio web de Operai.
- Inicie sesión en su cuenta o cree una nueva.
- Navegue a la configuración de su API.
- Generar una clave secreta.
- Copie la clave secreta generada.
Github_access_token
- Vaya al sitio web de Github.
- Inicie sesión en su cuenta o cree una nueva.
- Navegue a la configuración de su cuenta.
- Vaya a la sección "Configuración del desarrollador".
- Genere un nuevo token de acceso personal con los permisos necesarios.
KV_REST_API_URL Y KV_REST_API_TOKING
- Vaya al sitio web de Vercel.
- Inicie sesión en su cuenta o cree una nueva.
- Navegue a la sección de almacenamiento.
- Cree una nueva base de datos KV.
- Copie el kv_rest_api_url y kv_rest_api_token desde la pestaña .env.local .
Ollama_url
- Descargue Ollama y hágalo en ejecución.
- Si su instancia de Ollama no se ejecuta en la dirección IP y el puerto predeterminados, cambie la variable en el archivo .env.example para que se ajuste a su USECase
Ejecutar localmente
1.Clona el repositorio de EasyreadMe:
git clone https://github.com/xavimondev/easyreadme
2.Rename el .env.example a .env :
3. Dependencias de instalación:
# bun
bun install
# pnpm
pnpm install
# npm
npm install
# yarn
yarn install
6. Asegre el modo de desarrollo:
# bun
bun dev
# pnpm
pnpm dev
# npm
npm run dev
# yarn
yarn dev
Importante
A pesar de tener una plantilla para los paquetes NPM, todavía hay mucho trabajo por hacer e investigar sobre cómo obtener los tipos correctos de los paquetes.
Hoja de ruta
Expresiones de gratitud
- La animación de Sparkles fue tomada de este gran recurso creado por Josh W. Comeau
- El confeti alrededor del botón "Copiar código" se creó utilizando la web Lucide como referencia.
Licencia
Este proyecto tiene licencia bajo la licencia MIT ; consulte el archivo de licencia del MIT para más detalles.
