Guru

Uma aplicação de linha de comando que automatiza buscas no stackoverflow 🔍

Features

Buscar pelo termo passado como argumento de linha de comando
Mostrar Rapidamente no console a solução mais votada

🛒 Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:

Git
Node.js

Além disto é bom ter um editor para trabalhar com o código como VSCode

📀Executando a Aplicação

 # Clone este repositório
 git clone https://github.com/lucascprazeres/sof_guru
 
 # Acesse a pasta do projeto no terminal
 cd sof_guru
 
 # Instale as dependências
 $ yarn install ou
 $ npm i 
 
 # Execute a aplicação
 $ node src/index.js "sua pesquisa" ou
 $ yarn/npm start "sua pesquisa"

Além da pesquisa padrão, você também pode passar as seguintes opções:

--limit=valor: indica o número de resultados que você deseja ver
-u: deixa o texto em caixa alta
-l: deixa o texto em caixa baixa

Para usuários linux

Para executar o programa como no vídeo mostrado, através do comando "guru", basta seguir o seguinte passo a passo:

Crie, em sua home, a pasta bin, que conterá os seus próprios comandos.

mkdir ~/bin

Atualize o arquivo "guru" com o caminho para a pasta do seu projeto e mova-o para lá. Em seguida, você precisa "dizer" ao seu interpretador de comandos para tratar o novo arquivo com executável.

# exemplo de dentro do projeto
mv guru ~/bin
chmod +x ~/bin/guru

Finalmente, é preciso adicionar o caminho para a pasta recém criada ao seu PATH, para que o interpretador saiba onde procurar pelo código do comando.

echo "PATH="$PATH:$HOME/bin"" >> ~/.bashrc # ou .zshrc, se for o seu caso

não se esqueça que são dois símbolos de maior que ">>" no comando acima, ou isso pode te causar um problemão

Pronto! Agora é só reiniciar o seu terminal e o seu novo comando já estará disponível!

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

👨‍💻Autor

Como contribuir?

Com o projeto na sua máquina, basta criar uma branch para a sua feature/correção

$ git checkout -b sua_branch

Realize as mudanças, e, depois disso, salve-as e envie para este repositório, com

$ git add .
$ git commit -m 'conte o que você fez'
$ git push origin sua-branch

Ao acessar esse repositório via github, a opção de criar um pull request estará disponível.

Licença

Esse projeto se encontra sob a licença MIT. Para mais informações, acesse o arquivo LICENSE.

Feito com ❤️ por Lucas Prazeres 👋 Entre em contato!

lucascprazeres / guru