jsnevt/github_blog

Desafio3_Rckt

🚧 Github Blog - Concluído 🚀 🚧

Sobre • Funcionalidades • Layout • Como executar • Tecnologias • Contribuidores • Autor • Licença

💻 Sobre o projeto

Github Blog é uma aplicação que utiliza a API do GitHub para buscar issues de um repositório, dados do perfil e exibir elas em um blog.

Projeto frontend desenvolvido durante o curso online oferecido pela [Rocketseat].

---

⚙️ Funcionalidades

• Pessoas podem utilizar esta aplicação para alimentar seu blog capturando as informações do GitHub automaticamente
  • A aplicação faz comunicação com a API do GitHub para capturar as informações do repositório, dados do perfil e alimentar o blog do usuário.

---

🎨 Layout

O layout da aplicação está disponível no Figma:

Web

---

🚀 Como executar o projeto

O projeto foi feito usando o framework Vite com React

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

🧭 Rodando a aplicação web (Frontend)

# No prompt de comando:
# Crie uma pasta onde desejar
# Acesse a pasta e no terminal

# Clone este repositório
$ git clone https://github.com/jsnevt/github_blog.git

# No VSCode, abra a pasta onde o arquivo foi clonado e abra o projeto

# Dentro do terminal do VS Code, instale as dependências
$ npm i

# Acesse o terminal do VS e execute a aplicação em modo desenvolvimento
$ Digite "num run dev" (sem as aspas)

A aplicação será aberta - acesse http://localhost:5173

---

🛠 Tecnologias

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

Website (React + TypeScript)

• React
• React-hook-form
• React-markdown
• Styled-components
• Typescript
• Vite
• Moment
• API Github

Veja o arquivo package.json

👨‍💻 Contribuidores

💜 Sinceros agradecimentos a essa galera espetacular, quem contribuem para melhorar a vida das pessoas e o mundo!!! 👏 :)

Diego Fernandes 👨‍🚀	Cleiton Souza 👨‍🚀	Robson Marques 👨‍🚀	Claudio Orlandi 🚀	Vinícios Fraga 🚀	Hugo Duarte 🚀 🌐
Joseph Oliveira 🚀	Guilherme Rodz 🚀	Mayk Brito 🚀	João Paulo 🚀	Luke Morales 🚀	Luiz Batanero 🚀

💪 Como contribuir para o projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

---

🦸 Autor

📝 Licença

Este projeto esta sobe a licença MIT.

Feito com ❤️ por Jason Everton 👋🏽 Entre em contato!

---