Repositório oficial da app mobile do OpenRedu
Switch branches/tags
Nothing to show
Clone or download
#4 Compare This branch is 3 commits behind Openredu:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
OpenRedu
images-for-readme
LICENSE
README.md

README.md

![alt tag] (https://raw.githubusercontent.com/ThaisaMirely/mobile/master/images-for-readme/banner_pt.png)

Mas afinal, o que é OpenRedu?

O Openredu[1] é um ambiente de aprendizagem opensource[2] , idealizado para proporcionar formas de colaboração entre estudantes e professores utilizando diferente mídias e tipos de interação virtual. É uma plataforma em nuvem, seguindo as tendências do casamento entre tecnologia da informação e educação e favorecendo a realização de MOOCs[3] , como é feito, por exemplo, nas plataformas edX[4] e Coursera[5].

🌎 http://openredu.cin.ufpe.br :octocat: https://github.com/OpenRedu

O OpenRedu móvel nasceu do Redu móvel. Herdamos o código fonte e toda a estrutura de guidelines e documentação. Aos pouco estamos formando a cara e identidade do OpenRedu, remodelando seu código e atualizando práticas, dependências e funcionalidades.

🏁 Nossa versão atual ainda não está em loja 😭 (nos ajude contribuindo com a nossa comunidade 🙌), mas você pode checar a versão antiga Redu Móvel(código base da nossa aplicação).

Começando

Requisitos

Android

O OpenRedu móvel é desenvolvido em Java utilizando a plataforma Android. O projeto foi desenvolvido utilizando a IDE Eclipse e posteriormente migrado para a IDE Android Studio. Todas as dependências que anteriormente eram libs externas, agora se encontram como módulos do projeto. Novas dependências(bibliotecas), devem ser adicionada via Maven através do Gradle. Nossa ideia é desacoplarmos todas as libs em formato .jar

Estrutura do Projeto

Exemplo:

![alt tag] (https://raw.githubusercontent.com/ThaisaMirely/mobile/master/images-for-readme/project_structure.png)

Módulos

':app' = core da aplicaçaõ. Projeto principal

':openReduMobileAndroidPushRefresh' = módulo(lib) para push refresh

':openReduMobileViewPagerIndicator' = módulo(lib) para paginação

':openReduREST'= módulo(lib) Android REST

':openReduMobileWebCachedImageView' = módulo(lib) para tratamento de web cache de imagem.

Build Automática

O processo de build automática é realizado por meio da ferramenta Gradle. Atualmente é utilizada a versão 1.3.0, nativa do Android Studio.

classpath 'com.android.tools.build:gradle:1.3.0'

Para cada módulo do projeto há um arquivo build.gradle com as dependências e configurações do módulo.

Aqui mais informações sobre como utilizar o Gradle no Android Studio.

Exemplo - app módulo:

apply plugin: 'com.android.application'

android {
   compileSdkVersion 19
   buildToolsVersion '19.1.0'

   defaultConfig {
       applicationId "br.ufpe.cin.openredu"
       minSdkVersion 10
       targetSdkVersion 19
       versionCode 1
       versionName "1.0"
   }
  ...
}

dependencies {
   compile fileTree(include: ['*.jar'], dir: 'libs')
   testCompile 'junit:junit:4.12'
   compile 'com.android.support:appcompat-v7:19.1.0'
   compile 'com.android.support:support-v4:19.1.0'
   compile files('libs/buzzboxSDK-0.6.5.jar')
   compile project(':openReduREST')
   compile project(':openReduMobileAndroidPushRefresh')
   compile project(':openReduMobileViewPagerIndicator')
   compile project(':openReduMobileWebCachedImageView')
}

Contribuir com o projeto

Configurações

com seu ambiente configurado(Android Studio + SDK + Gradle):

  • Importe no Android Studio o projeto mobile/OpenRedu. Exemplo:

![alt tag] (https://raw.githubusercontent.com/ThaisaMirely/mobile/master/images-for-readme/import_project.png)

  • Compile e execute o projeto para testar e iniciar o desenvolvimento.
  • Caso não tenha o plugin do Findbugs instalado, deverá realizar esse passo.

Pull requests

Os passos para contribuir com a evolução do código, seja para resolução de issue ou criação de features são os seguintes:

  • Criar um branch novo
  • Realizar mudanças ou adicionar a feature
  • Commitar mudanças e enviá-las para o remoto
  • Realizar pull request

Qualidade de Código

Integrado ao Android Studio há um ótima ferramenta de análise estática chama Lint.

Utilizamos ela para gerarmos nossos relatórios de saúde do código.

Junto com o Lint, também utilizamos o Findbugs, que é mais voltado para a análise estática com foco em padrão de desenvolvimento Java, visto que o Lint é direcionado para especificações do projeto Android.

Para utilizar junto com seu ambiente Android Studio, é necessário que seja instalado um plugin.

Aqui há um tutorial que pode lhe ajudar

🏁 Sempre que antes de realizar um pull request , cheque(executando as ferramentas estáticas) se a versão mais atual do relatório está igual a que foi gerada por você. Caso não esteja(o número tenha aumentado), corrija antes de submeter sua contribuição.

Reportando issues

🚧 Estamos criando um template para abertura de bugs, melhorias e novas funcionalidade.

Estilo de Código

Estamos construindo nosso Guia de estilo. 🚧😁 Enquanto ele não está pronto, você pode seguir os padrões abaixo para garantir a qualidade do seu código.

🏁 Leia com atenção antes de submeter seu pull request 😉.

Comunidade

O OpenRedu está presente nos seguintes sítios:

Licença

   								       GNU GENERAL PUBLIC LICENSE
                            Version 2, June 1991

Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

🏁 Para informação completa acesse o arquivo LICENSE, na raiz do projeto.