Download makeread.me makeread.me

makeread.me

Dados do site

1.0.0

Baixar

Makeread.me

Um gerador de leitura incrível para iniciar seus projetos!

Explore os documentos »

Ver demo. Relatório bug. Recurso de solicitação

Índice

Índice
Sobre o projeto
- Construído com
Começando
- Pré -requisitos
- Instalação
Roteiro
Contribuindo
Licença
Contato
Agradecimentos
Perceber

Sobre o projeto

Captura de tela

Um dos desafios com a construção e a contribuição do software de código aberto é que, embora muitos projetos tenham funcionalidades incríveis, elas geralmente perdem o alcance de um público mais amplo devido à falta de instruções de instalação claras e amigáveis. Além disso, a falta de vitrine eficiente de seus casos de uso também contribuem para o menor alcance desses projetos.

Embora existam modelos de leitura que podem ajudar a resolver isso, o processo de preencher manualmente esses modelos pode ser demorado e tedioso. É aí que entra nosso projeto Makeread.me.

Apresentando o Makeread.me, um gerador de leitura automatizado que pode revolucionar como você cria a documentação do seu projeto. Foi projetado para:

Economize seu tempo valioso, aprimorando seu foco no desenvolvimento,
Automatizar tarefas redundantes e,,
Implemente os princípios secos (não se repita) para sua documentação.

É gratuito, de código aberto e altamente personalizável. Sinta -se à vontade para modificar nossos modelos para atender às suas necessidades. Se você achar que um componente específico está faltando, é mais do que bem -vindo a contribuir e expandir o projeto.

Facilitamos a contribuir para o projeto usando modelos de Nunjucks e JSON para mapeamento programático. Aproveite os benefícios da documentação clara e concisa do projeto com o Makeread.me!

Construído com

Este projeto foi construído com as seguintes tecnologias:

Next.js
Reagir
Shadcn/ui
React fort fort
TypeScript
Expressar

Começando

Este é um exemplo de como você pode fornecer instruções sobre como configurar seu projeto localmente. Para obter uma cópia local em funcionamento, siga estas etapas simples de exemplo.

Pré -requisitos

Este projeto exige que o fio seja instalado em seu sistema. Se você não o tiver instalado, pode seguir estas etapas:

Instale o fio globalmente usando o NPM (Node Package Manager). Abra seu terminal e corra:
```
npm install -g yarn
```
Certifique -se de ter o Node.js e o NPM instalados antes de executar fios.
Verifique se o fio foi instalado em sua máquina executando o seguinte comando em seu terminal:
```
yarn --version
```
Se o fio tiver sido instalado corretamente, seu terminal deve exibir a versão do fio instalada em sua máquina.

Agora você está pronto para usar o YARN para gerenciar e versificar as dependências do seu projeto!

Instalação

Siga as seguintes etapas para instalação bem -sucedida:

Clone o repositório: Comece clonando o repositório da sua máquina local.
```
 https://github.com/ShaanCoding/makeread.me
```
Instale os pacotes de front -end: Navegue até o diretório "/frontend" e instale os pacotes de fios necessários executando o seguinte comando em seu terminal:
```
yarn install
```
Instale os pacotes de back -end: Da mesma forma, navegue até o diretório "/back -end" e instale os pacotes de fios necessários executando o seguinte comando em seu terminal:
```
yarn install
```
Configurar o ambiente:
- No diretório "/back -end", copie o conteúdo do arquivo ".env.example" e crie um novo arquivo chamado ".env". Ajuste as variáveis de ambiente de acordo com seus requisitos ou você pode deixá -las como estão.
- Navegue para "Frontend/API/Generated/Readmegenerator.ts" e defina o parâmetro base na sua rota da API de back -end. Por exemplo, se você estiver executando o back -end em seu servidor local na porta 8080, você deve definir:
```
BASE: "http://localhost:8080/api" ;
```
Execute o back -end: navegue para o diretório "back -end" e digite o seguinte comando em seu terminal para executar seu servidor de back -end:
```
yarn dev
```
Execute o front -end: Finalmente, navegue para o diretório "Frontend" e digite o seguinte comando em seu terminal para executar seu servidor de front -end:
```
yarn dev
```
Agora, seu aplicativo deve estar em funcionamento com sucesso!

Roteiro

O roteiro inclui objetivos concluídos e futuros. Aqui está o que realizamos e esperamos:

Continuamos nosso compromisso em melhorar e expandir as capacidades do MakeRead.me para fornecer uma experiência de geração de leitura eficiente e sem costura aos nossos usuários.

Veja os problemas abertos para obter uma lista completa dos recursos propostos (e problemas conhecidos).

Contribuindo

As contribuições são o que tornam a comunidade de código aberto um lugar tão incrível para aprender, inspirar e criar. Quaisquer contribuições que você faz são muito apreciadas .

Se você tiver uma sugestão que melhoraria isso, bifór -l e crie uma solicitação de tração. Você também pode simplesmente abrir um problema com a tag "aprimoramento". Não se esqueça de dar uma estrela ao projeto! Obrigado novamente!