Skip to content

johncarpenter/AndroidFramework

Repository files navigation

Android Framework

Circle CI

A simple template Android application to help getting started with development

The project is setup using:

Testing

To run unit tests on your machine:

./gradlew test

Code Quality

Code check tools and process attributed to Ribot (https://github.com/ribot/ribot-app-android) Android App. This repo has a fantastic template if you are looking for other Android examples

Code Analysis tools

The following code analysis tools are set up on this project:

  • PMD: It finds common programming flaws like unused variables, empty catch blocks, unnecessary object creation, and so forth. See this project's PMD ruleset.
./gradlew pmd
  • Findbugs: This tool uses static analysis to find bugs in Java code. Unlike PMD, it uses compiled Java bytecode instead of source code.
./gradlew findbugs
./gradlew checkstyle

The check task

To ensure that your code is valid and stable use check:

./gradlew check

This will run all the code analysis tools and unit tests.

Licence

Copyright 2015 2Lines Software Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.