An open API service indexing awesome lists of open source software.

https://github.com/carlos-hfc/github-blog


https://github.com/carlos-hfc/github-blog

github-api react react-hook-form react-query rocketseat rocketseat-ignite tailwindcss tanstack-react-query typescript vite zod

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          




# :bulb: Sobre

Um blog utilizando as issues de um repositório como artigos feito em React como desafio do Ignite da Rocketseat.

# :page_with_curl: Pré-requisitos

1. Antes de começar, certifique-se de ter o Node.js instalado em sua máquina.

Node.js

# :gear: Configuração

1. Clone o repositório para sua máquina local:

```bash
git clone https://github.com/carlos-hfc/github-blog
```

2. Acesse o diretório do projeto:

```bash
cd github-blog
```

3. Instale as dependências:

```bash
npm install
```

4. Crie um arquivo `.env.local` na raiz do projeto e adicione o usuário do GitHub e o nome de um repositório de sua escolha, dos quais serão utilizados para buscar as issues.

```env
VITE_GITHUB_USER="user-name"
VITE_GITHUB_REPOSITORY="my-repo"
```

5. Rode a aplicação

```bash
npm run dev
```

# :computer_mouse: Uso da aplicação

1. Abra o navegador e acesse [http://localhost:3000](http://localhost:3000)
2. Visualize os posts publicados
3. Filtre um ou mais posts
4. Acesse o post de sua escolha

# :computer: Tecnologias utilizadas


React
TypeScript
Tailwind CSS

# :page_facing_up: Licença

Este projeto está licenciado sob a [Licença MIT](LICENSE).