Skip to content

Latest commit

 

History

History
78 lines (69 loc) · 9.51 KB

README.md

File metadata and controls

78 lines (69 loc) · 9.51 KB
Raw

Instruções para criar um projeto utilizando esta arquitetura:

Este projeto contém um projeto de uma aplicação desktop (Linux plasma KDE bem suportado e OSX parcialmente suportado) e mobile (Android bem suportado e iOS parcialmente suportado).

Para usar esta arquitetura, faça:

  1. Crie um fork deste projeto
  2. Clone o projeto forkado para a sua máquina
  3. Renomeie a pasta clonada e o arquivo tcc.pro para o nome do seu projeto (pode ser o nome do seu aplicativo)
  4. Importe o projeto no QtCreator e siga os passos seguintes para configurar a customização do seu aplicativo.
  5. Abra o arquivo config.json na raíz do projeto (manualmente, usando algum editor) ou pelo QtCreator em Resources config.qrc/config.json e configure as propriedades do aplicativo. Os valores pré-definidos foram setados apenas como exemplo.
  6. Abra o arquivo AndroidManifest.xml no QtCreator e renomeie o package name, de org.qtproject.example para o nome do pacote do seu app.
  7. Para suportar push notification, crie um projeto do firebase
    • Adicione o suporte a push-notification ao projeto, configure as opções e ao final do wizard de configuração, exporte o arquivo de configuração google-services.json e salve na pasta android (substitua o existente - ele é apenas um exemplo).
  8. Edite o arquivo build.gradle e renomeie o valor da propriedade defaultConfig.applicationId de org.qtproject.example para o package name do seu app. Essa alteração é necessária para o funcionamento do firebase.
  9. Para customizar a identidade do seu app, você deve editar os seguintes arquivos:
    • Edite o arquivo android/res/values/colors.xml e defina as cores do app. A cor definida em colorPrimary é utilizada como cor de fundo do ícone nas notificações de push ou local (enviadas pelo app sem ser via push).
    • Edite o arquivo android/res/values/styles.xml e configure as propriedades de estilo do app. Por padrão, o app está configurado para usar um pacote de estilo de compatibilidade com versões antigas do Android, ele será baixado durante o build e empacotado no APK como uma dependência. Ele está definido no arquivo build.gradle na linha 34 (implementation 'com.android.support:appcompat-v7:+'). Para que ele seja aplicado no app, é feito uma atribuição no construtor do CustomActivity em: QT_ANDROID_THEMES = new String[] {"Theme.AppCompat"};. Para ver outras opções e propriedades de estilo acesse a página Styles and Themes.
  10. Adicione os ícones do seu app em android/res/drawable-(...)dpi. O projeto vem com ícones nos tamanhos ideais, substitua pelos seu ícones usando os tamanhos dos ícones fornecidos. Você pode usar alguma ferramenta online para gerar os ícones, tais como: Android Asset Studio ou Android icon studio. Veja dicas de como gerar ícones usando o Android Studio.
  11. Gere também os ícones com fundo transparente para uso na notificação, requerido para versões a partir do Lollipop (API Level 21). Logo, para cada ícone do lançador presente em android/res/drawable-(...)dpi mantenha uma versão com fundo transparente. Uma cor de fundo será definida via java na classe que envia a notificação para a área de notificação do sistema. Perceba que existe um ícone de nome icon_transparent.png em cada drawable. Mantenha este nome, pois ele é referenciado na classe SystemNotification.java. Para mais detalhes sobre essa questão do ícone transparente, leia essa discussão.
  12. Na raiz do projeto, na pasta images, mantenha uma cópia dos ícones do app (versão transparente e normal). Adicione também a imagem do navigation drawer (utilizada no menu lateral) substituindo as versões fornecidas como exemplo. A imagem default_user_image.svg é utilizada na imagem de perfil do usuário quando ela não tiver sido definida (caso você utilize esse recurso no seu app). Você pode substituir essa imagem por uma que achar melhor, porém, mantenha o mesmo nome do arquivo.
  13. Para adicionar uma imagem de splash, exibida na inicialização do app, adicione uma imagem com as resoluções recomendadas neste link em cada drawable (android/res/drawable-(...)dpi). Para que ela seja utilizada, basta descomentar as linhas 60 e 61 no arquivo AndroidManifest.xml. Porém, existe boas práticas e melhores implementações para uso do splash que vão além de configuração via xml. Por exemplo, a dica publicado neste post [ou aqui] (https://www.bignerdranch.com/blog/splash-screens-the-right-way/).
  14. E por fim, escreva os seus plugins. O seu app deve fornecer as funcionalidades através de plugins que você pode implementar a partir dos exemplos fornecidos. Os plugins não são mapeados em arquivo qrc e você deve criá-los manualmente mantendo-os em uma pasta com o nome do seu plugin com um arquivo json de configuração e os aquivos qml necessários, além de imagens e arquivos js. Tudo que tiver na pasta do plugin será empacotado no APK. Não utilize o wizard de adição de arquivos do QtCreator, pois ele vai adicionar o novo arquivo em qml.qrc, que contém os componentes internos e reutilizáveis da arquitetura, acoplando plugins e núcleo violarndo um requisito não funcional desta arquitetura. Os plugins não precisam estar mapeados em arquivos qrc, pois são independentes entre sí e serão conhecidos e carregados dinamicamente. Uma lista de objetos contendo todos os arquivos dos plugins pode ser acessado por qualquer componente, veja um exemplo no arquivo Menu.qml.

Requisitos para gerar um app android:

  1. Qt Creator for Android Versão 5.9. Baixe aqui
  2. Android NDK R14 ou superior. Baixe aqui
    • No caso do NDK, é necessário apenas baixar o pacote, descompactá-lo e informar o path da pasta nas configurações do QtCreator.
  3. Android SDK Tools com os seguintes pacotes abaixo (instalação na sessão seguinte). Baixe aqui
    • Android SDK Build-Tools >= 26
    • Android SDK Platform-Tools >= 26
    • Android SDK Tools Versão >= 26
    • Android 5.1 (API 22 SDK Platform)
    • Android 6.0 (API 23 SDK Platform)
    • Android 7.1.1 (API 25 SDK Platform)
    • Android Support Repository
    • Google Play Licensing Library
    • Google Play Services
    • Google Repository
  4. Java JDK localmente instalado.
  5. Gradle versão >= 4.3.1 localmente instalado. Esse projeto está configurado para usar a versão mais recente do Gradle.
    • Veja como instalar no seu sistema. O Gradle está nos repositórios das prinicipais distribuições Linux.
    • Leia as opção de build desta versão aqui.
    • No primeiro build, o gradle vai baixar algumas libs requeridas para compilação do projeto e salvar na home do usuário. A partir do segundo build ele usará as libs salvas localmente, tal como as libs do Firebase.
  6. Adicione os paths do JDK, Android SDK e NDK nas configurações do QtCreator. Para isso, faça:
    • Clique no menu Tools -> Options -> Devices -> Android e informe o caminho absoluto dos kits e em seguida clique em Ok.

Instalando as dependências manualmente (sem android studio):

  1. No diretório do SDK, acesse tools/bin e execute os comandos abaixo:

    • ./sdkmanager "tools"

    • ./sdkmanager "platform-tools"

    • ./sdkmanager "build-tools;26.0.2"

    • ./sdkmanager "platforms;android-22"

    • ./sdkmanager "platforms;android-23"

    • ./sdkmanager "platforms;android-24"

    • ./sdkmanager "platforms;android-25"

    • ./sdkmanager "extras;android;m2repository"

    • ./sdkmanager "extras;google;market_licensing"

    • ./sdkmanager "extras;google;google_play_services"

    • ./sdkmanager "extras;google;m2repository"

    • android extras é requerido pelo Firebase para o Push Notification

Observações:

  1. As APIs Level (contendo System Images) é necessário somente para testar o app em um emulador.
  2. Caso queira testar o aplicativo em um emulador, Push Notification não funcionará.
  3. Links úteis: