readme-cli-create, detalhes do projeto e minha primeira experincia desenvolvendo um projeto prprio e aberto ao pblico

Incio da ideia

Depois de um bom tempo estudando JS, Node etc. e criando diversos repositrios no GitHub tive uma pequena ideia, algo que iria facilitar um pouco minha vida na hora de escrever os READMEs dos meus repositrios, surge ento o readme-cli-create

O que o projeto?

O projeto no nada de mais, basicamente o que eu criei foi uma CLI (Command Line Interface) onde nela passamos alguns dados que vo melhor explicado mais a frente, com isso gerado um arquivo README.md para ser usado no seu repositrio GitHub, com uma estrutura j pr-definida e o suficiente para agilizar o processo e no ter que comear a escrever tudo do zero, a parte boa que alem de tudo est CLI foi colocada no NPM, ou seja, voc pode instalar ela na sua maquina de forma global e usa-l em todas / grande maioria das pastas do seu PC.

Como funciona?

Depois de instalarmos ela basta usarmos o comando readme-cli-create no diretrio que queremos criar o arquivo README.

Aps rodarmos esse comando iremos receber algumas perguntas, onde as respostas que dermos vo ser usadas para j ajustar algumas partes do nosso arquivo.

A prxima etapa com a CLI, ela ir verificar algumas coisas e se tudo der certo iremos ver uma tela parecida com essa dizendo que nosso arquivo foi gerado sem nenhum problema.

Aps isso podemos ver se realmente deu tudo certo vendo o arquivo em si.

Note que em algumas partes, como podemos ver na primeira imagem, que uma das nossas respostas foi usada para ser o ttulo e a descrio do nosso arquivo README

E como est sendo a experincia de desenvolver isso?

Primeiro que esse projeto era pra ser algo particular, a ideia no era deixar ele pblico e muito menos publicar no NPM, ento aqui temos a primeira grande mudana de como esta sendo desenvolver esse projeto, antes como era algo particular de certa forma eu no precisava me preocupar com alguns detalhes, agora com o projeto pblico isso j muda.

Em compensao a vontade agora de expandir ainda mais essa ideia, melhorando a parte do usurio, colocando novos modelos para os READMEs, mas acima de tudo, conseguir aprender algo novo sempre, esse outro ponto muito importante dessa jornada at aqui, aprender algo e realmente colocar isso em prtica e at mesmo entendo melhor alguns conceitos ou ideias.

Confesso que j cai em alguns problemas durante o desenvolvimento que tive certa dificuldade para resolver, mas hoje j sei como posso passar por cima disso, um dos exemplos que mais me marcou foi a verificao para ver se j existe um arquivo "README.md" no diretrio que o comando foi executado, tive srios problemas nessa parte e resolvi isso depois com poucas linhas, talvez seja a melhor soluo? Acho que com certeza no, mas por enquanto o que da para ser feito.

Um detalhe importante que eu vejo que eu melhorei a na organizao do que eu preciso fazer em relao ao projeto, realmente separar os problemas em partes menores, conseguir estruturar melhor as ideias e muito mais.

Essas so umas das coisas mais importantes que eu pude ver que aprendi fazendo esse projeto, alm claro do bsico, que entender mais a linguagem que usei e tudo mais.

Recomendaes

Eu pessoalmente recomendo muito dar uma olhada no projeto no GitHub caso queira usa-lo, existem algumas coisas que no cheguei a explicar, como por exemplo o parmetro "-y" na hora de executar o comando da CLI, isso pode fazer a diferena na hora de usar a CLI e l tambm est tudo mais detalhado sobre o projeto, o que necessrio ter no PC para usar a CLI e muito mais.

GitHub: readme-cli-create

NPM: readme-cli-create

Linkedin: Luigi Belanda