lucasarieiv / github-badges

Application made to create badges for your readme 📑

Github Badges é uma aplicação web, construída com ReactJS, visando facilitar a criação de badges para README de projetos. Acesse-a aqui

---

🚀 Instalação e execução

Para clonar e executar a aplicação, você precisará ter instalado em sua máquina o Git, Node.js + Yarn. Com todos os programas instalados, execute as seguintes linhas de comando:

# Clone esse repositório
$ git clone https://github.com/eugustavo/github-badges

# Acesse o repositório
$ cd github-badges

# Instale as dependências
$ yarn install

# Inicie a aplicação
$ yarn start

🤔 Como contribuir

Se quiser contribuir para essa aplicação, seja corrigindo algum problema, adicionando comentários ou melhorando o código/documentação, você pode seguir esse tutorial abaixo:

• Faça um fork desse repositório;
• Entre no seu perfil no GitHub e faça um clone do repositório que você fez o fork;
• Crie uma branch com a sua alteração: git checkout -b minha-alteracao;
• Faça as alterações necessárias no código ou na documentação;
• Faça commit das suas alterações: git commit -m 'feat: Minha nova feature';
• Faça push para a sua branch: git push origin minha-alteracao;
• Agora é só abrir a sua pull request no repositório que você fez o fork;

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

---

Feito com ♥ por Gustavo Souza 👋 Contato