? Visão geral
EasyReadMe é um projeto que simplifica a criação de leitura, gerando leitura visualmente impressionante usando modelos pré-projetados e IA. Ele suporta a geração de ReadMes para projetos JavaScript/TypeScript, Rust, Java, GO, PHP e Python. Ele se baseia em uma ampla gama de tecnologias e bibliotecas, incluindo React, Tailwind CSS, TIPTAP, OpenAI e muito mais.
? Índice
❤️ Recursos
Pilha
Resumo do projeto
Configurando
Execute localmente
? ️ Roadmap
Agradecimentos
? Licença
Características
Introdução.MP4
Lista de modelos
modelos.mp4
Personalize ReadMe
personalize.mp4
Seções de IA
ai-section.mp4
Comandos embutidos
Commands.mp4
Menu de bolhas
bubble-menu.mp4
URL de imagem de banner editável
update-banner.mp4
Créditos de IA gratuitos, chave de API personalizada, corrida local
api-offline-gerações.mp4
Pilha
- Próximo: Uma estrutura para criar aplicativos React renderizados pelo servidor.
- REACT: Uma biblioteca JavaScript para criar interfaces de usuário.
- TypeScript: Um superset digitado de JavaScript que compila com JavaScript simples.
- Shadcn/UI: fornece componentes lindamente projetados para a interface do usuário.
- Tailwindcss: uma estrutura CSS de utilitário para o desenvolvimento rápido da interface do usuário.
- VAUL: Um componente de gaveta não sincronizado para reação.
- Sonner: Um componente de brinde opinativo para reagir.
- TippAp/núcleo: uma estrutura de editor de texto rico altamente personalizável e extensível.
- SWR: lida com a busca, cache e sincronização de dados com o servidor.
- Zustand: Uma biblioteca de gerenciamento de estado pequena, rápida e escalável.
- Lucide: ícones bonitos e consistentes.
Resumo do projeto
- SRC : diretório de código -fonte primário.
- SRC/APP : contém a lógica e componentes do aplicativo principal.
- SRC/Componentes : Casas componentes de interface do usuário reutilizáveis.
- SRC/GAYS : ganchos de reação personalizados para gerenciar efeitos estaduais e colaterais.
- SRC/lib : funções de utilidade e módulos auxiliares.
- SRC/Serviços : Módulos para interagir com APIs externas.
- SRC/Styles : Estilos globais e módulos CSS.
- SRC/Tipos : Definições do tipo TypeScript.
- SRC/UTILS : Funções de utilidade diversas.
- Público : Diretório Público para ativos estáticos e criação de saída.
Configurando
OpenAi_API_KEY
- Vá para o site do Openai.
- Faça login na sua conta ou crie uma nova.
- Navegue até suas configurações de API.
- Gerar uma chave secreta.
- Copie a chave secreta gerada.
Github_access_token
- Vá para o site do GitHub.
- Faça login na sua conta ou crie uma nova.
- Navegue até as configurações da sua conta.
- Vá para a seção "Configurações do desenvolvedor".
- Gere um novo token de acesso pessoal com as permissões necessárias.
Kv_rest_api_url e kv_rest_api_token
- Vá para o site da Vercel.
- Faça login na sua conta ou crie uma nova.
- Navegue até a seção de armazenamento.
- Crie um novo banco de dados KV.
- Copie o kv_rest_api_url e o kv_rest_api_token na guia .env.local .
Ollama_url
- Faça o download do Ollama e faça com que seja executado.
- Se sua instância de Ollama não estiver em execução no endereço IP e porta padrão, altere a variável no arquivo .env.example para ajustar sua USECASE
Execute localmente
1.Cone o repositório EasyReadMe:
git clone https://github.com/xavimondev/easyreadme
2.Renome o .env.example para .env :
3. Instale as dependências:
# bun
bun install
# pnpm
pnpm install
# npm
npm install
# yarn
yarn install
6. Iniciar o modo de desenvolvimento:
# bun
bun dev
# pnpm
pnpm dev
# npm
npm run dev
# yarn
yarn dev
Importante
Apesar de ter um modelo para pacotes NPM, ainda há muito trabalho a ser feito e pesquisar sobre como obter os tipos corretos dos pacotes.
Roteiro
Agradecimentos
- A animação Sparkles foi retirada deste grande recurso criado por Josh W. Comeau
- O botão "Copiar código" foi criado usando a Web Lucide como referência.
Licença
Este projeto está licenciado sob a licença do MIT - consulte o arquivo de licença do MIT para obter detalhes.
