/news-app

News app developed in React

Primary LanguageTypeScriptMIT LicenseMIT

📰 News

Site de notícias do Brasil, Portugal e Estados Unidos

💻 Sobre o projeto

Aplicação de notícias usando a API https://newsapi.org/ de forma whitelabel, usando o país como "tema".


📂 Estrutura

Esse monorepo contem dois pacotes, o design-system e news-app

@design-ops/design-system

Pacote simulando a geração de design tokens usando a ferramenta do Style Dictionary que permite que seja definido os tokens dos temas em um único formato (JSON) para que seja distribuído em várias plataformas e formatos de arquivos (JS, CSS).

Nesse pacote vai encontrar a pasta themes que serve para separar os tokens por tema.

@design-ops/news-app

Onde a aplicação foi desenvolvida usando Next.js.


🎨 Layout

Mobile

Página inicial

US PT BR

Drawer (Menu)

US PT BR

Página de categoria

US PT BR

Página de busca

US PT BR

Desktop

Página inicial

image

Página de categoria

image

Página de busca

image


🚀 Como executar o projeto

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

# Clone este repositório
$ git clone git@github.com:rbalves/news-app.git

# Acesse a pasta do projeto
$ cd news-app

# Para preparar o projeto, instalar e fazer o link das dependências
$ npm run bootstrap

# Execute a aplicação em modo de desenvolvimento
$ npm run dev

# A aplicação será aberta na porta:3000 - acesse http://localhost:3000

🛠 Tecnologias

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

💪 Como contribuir no 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


Rafael Alves
🚀

Linkedin Badge Gmail Badge


📝 Licença

Este projeto esta sobe a licença MIT.

Feito com ❤️ por Rafael Alves 👋🏽 Entre em contato!