https://github.com/jsnevt/github_blog
Desafio3_Rckt
https://github.com/jsnevt/github_blog
axios firacode fontawesome-icons fortawesome moment react reacthookform reactmarkdown reactrouterdom spinner styled syntaxhighlight typescript useform vite zod
Last synced: 2 months ago
JSON representation
Desafio3_Rckt
- Host: GitHub
- URL: https://github.com/jsnevt/github_blog
- Owner: JsnEvt
- Created: 2023-03-23T22:31:06.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-29T10:46:59.000Z (about 1 year ago)
- Last Synced: 2025-02-01T00:43:05.491Z (4 months ago)
- Topics: axios, firacode, fontawesome-icons, fortawesome, moment, react, reacthookform, reactmarkdown, reactrouterdom, spinner, styled, syntaxhighlight, typescript, useform, vite, zod
- Language: TypeScript
- Homepage:
- Size: 1.03 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🚧 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
- [x] 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](https://git-scm.com),
[Node.js](https://nodejs.org/en/).
Além disto é bom ter um editor para trabalhar com o código como [VSCode](https://code.visualstudio.com/)
#### 🧭 Rodando a aplicação web (Frontend)
```bash
# 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](https://reactjs.org/) + [TypeScript](https://www.typescriptlang.org/))
- **[React](https://github.com/facebook/react)**
- **[React-hook-form](https://github.com/react-hook-form/resolvers)**
- **[React-markdown](https://github.com/remarkjs/react-markdown)**
- **[Styled-components](https://github.com/styled-components/styled-components)**
- **[Typescript](https://github.com/microsoft/TypeScript)**
- **[Vite](https://github.com/vitejs/vite)**
- **[Moment](https://github.com/moment/moment)**
- **[API Github](https://github.com/public-apis/public-apis)**
> Veja o arquivo [package.json](https://github.com/JsnEvt/coffeedelivery/blob/main/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](./CONTRIBUTING.md)
---
## 🦸 Autor
[](https://www.linkedin.com/in/jason-everton-041226223/)
[](mailto:[email protected])
## 📝 Licença
Este projeto esta sobe a licença [MIT](./LICENSE).
Feito com ❤️ por Jason Everton 👋🏽 [Entre em contato!](https://www.linkedin.com/in/jason-everton-041226223/)
---