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

https://github.com/jonataslaguna/trybe-news

Projeto React com TypeScript que utiliza a API do IBGE para exibir notícias.
https://github.com/jonataslaguna/trybe-news

api css3 html reactjs reacttestinglibrary typescript usecontext useeffect-hook usestate

Last synced: 4 months ago
JSON representation

Projeto React com TypeScript que utiliza a API do IBGE para exibir notícias.

Awesome Lists containing this project

README

          

# Trybe News App

Este é um projeto React que utiliza a API do IBGE para exibir as notícias mais recentes do site. Ele permite que os usuários visualizem a notícia mais recente na página inicial, além de fornecer opções de filtro por Mais Recentes, Realese, Notícias e Favoritas. É possivel favoritar também e ler as notícias completas através de um link.

## Como Usar

Para utilizar a aplicação basta acessar esse link, ou siga os passos descritos para a [instalação](#instalação) localmente

  • Na página inicial você encontrará a notíca mais recente destacada, alguns botões para filtragem: 'Mais Recentes', 'Realese', 'Notícias', 'Favoritas', e o restante das notícias logo abaixo


    ![Página Home](/public/images/01.png)

    #

  • Caso queira ver mais notícias basta clicar no botão 'Mais Notícias', no final da página

    ![Página Home](/public/images/02.png)

    #

  • É possivel favoritar a notícia que quiser, e ela ficará salva na página de favoritos, mesmo após sair da aplicação

    ![Página Home](/public/images/03.png)

    #

  • Para ler a notícia completa basta clicar no botão 'Leia a notícia aqui' e você será direcionado para a página do IBGE com a noticia completa

    ![Página Home](/public/images/04.png)

    #

    ## Para Instalar Localmente

    #### Pré-requisitos:

    Antes de começar, certifique-se de ter instalado o Node.js e o npm (gerenciador de pacotes do Node.js) em sua máquina.

    ## Instalação

    ### Siga estas etapas para configurar e executar o projeto em sua máquina:

  • Após realizar um clone do repositório navegue até o diretório do projeto e instale as dependências do projeto usando o comando:

    npm install

  • Após a instalação, você já pode iniciar localmente. Certifique-se de estar no diretório raiz do projeto e execute o seguinte comando:

    npm run dev

    Isso iniciará o servidor de desenvolvimento e abrirá automaticamente o aplicativo no seu navegador padrão.

    ## Contribuição
    ### Se você deseja contribuir para este projeto, siga estas etapas:

    1. Faça um fork do projeto
    2. Crie uma nova branch (`git checkout -b feature/sua-feature`)
    3. Faça commit das alterações (`git commit -am 'Adicione sua feature'`)
    4. Faça push para a branch (`git push origin feature/sua-feature`)
    5. Abra um Pull Request

    ## Contato

    Se você deseja entrar em contato comigo, sinta-se à vontade para enviar um e-mail para [jonataslaguna.js@gmail.com](mailto:jonataslaguna.js@gmail.com).