MariaE-duarda/github-issues

Github Blog

Uma aplicação web que utiliza a API do GitHub para buscar issues de um repositório, dados do perfil e exibi-los como um blog.

Table of Contents

1. Sobre o projeto
   • Construído com
2. Começando
   • Instalação
3. Contribuir
4. Licença
5. Contato

Sobre o projeto

O Github blog é uma aplicação web que tem como objetivo buscar os dados de um determinado usuário do Github e exibi-los como um blog, além de mostrar com mais detalhes as issues presentes neste mesmo repositório da aplicação no Github, permitindo também a pesquisa por issues específicas.

(back to top)

Construído com

• Typescript
• React.js
• Vite
• Font Awesome
• React Hook Form
• React Router Dom
• React Markdown
• date-fns
• Zod
• Axios

(back to top)

Começando

Você precisa ter o NodeJs instalado

Instalação

1. Clonar o repositório

   git clone https://github.com/matheuslima99/github-blog

2. Instalar pacotes NPM

   npm install

3. Para executar no seu dispositivo

   npm run dev

(back to top)

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ê fizer são muito apreciadas.

1. Fork do Projeto
2. Crie sua ramificação de recursos (git checkout -b feature/AmazingFeature)
3. Confirme suas alterações (git commit -m 'Add some AmazingFeature')
4. Empurre para a Branch (git push origin feature/AmazingFeature)
5. Abra uma Pull Request

(back to top)

Licença

Distribuído sob a licença MIT. Ver LICENSE.txt para maiores informações.

(back to top)