android-template - GitLite

KO | EN

gitlite — search

#python #typescript #llm #machine-learning #rust #deep-learning #macos #windows #awesome #cli #vue #pytorch #security #ios

android-template

(★ 130)

This template provides a starting point for open source Android projects at Uber.

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - feature_request.md
- - ci.yml
- ISSUE_TEMPLATE.md
- PULL_REQUEST_TEMPLATE.md
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- dependencies.gradle
- publish-docs.gradle
- spotless.gradle
- build.gradle
- gradle.properties
- build.gradle
- gradle.properties
- proguard-rules.txt
- copyright.java
.gitignore
build.gradle
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
gradle.properties
gradlew
gradlew.bat
LICENSE.txt
lint.xml
README.md
RELEASING.md
settings.gradle

# Installation Guide

1. Get the code

git clone https://github.com/uber/android-template

Downloads the entire project code from GitHub to your computer.

cd android-template

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

- [ ] Update `settings.gradle` to point to the modules you added

Builds the project using Gradle.

- [ ] Update `dependencies.gradle` and respective `build.gradle` files to make sure dependencies are hooked up and compiling properly

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# android-template [![Build Status](https://travis-ci.org/uber/android-template.svg?branch=master)](https://travis-ci.org/uber/android-template)

This template provides a starting point for open source Android projects at Uber.

## Scaffolding Provided

This repository provides the following components that are common to our open source projects:

- CHANGELOG.md
- CONTRIBUTING.md
- LICENSE.txt
- README.md
- RELEASING.md
- Issue & Pull Request Templates
- Git Ignore
- Checkstyle
- Links to Codestyle
- Lint
- Dependency Management
- Maven Central Release Script
- Proguard Config

## Checklist

- [ ] Clone this repository into a folder of your project's name `git clone git@github.com:uber/android-template.git MY_PROJECT`. Or if you're copying the folder, don't forget hidden files!
- [ ] Reinitialize git
    - [ ] Delete the `.git` folder
    - [ ] Start a git repo with `git init`
    - [ ] Make initial git commit with all files
- [ ] Update the `PROJECT_NAME` inside the files `./github/ISSUE_TEMPLATE.md` and `./github/PULL_REQUEST_TEMPLATE.md` to your project’s name.
- [ ] Move your project's modules into the sample project
    - [ ] Update `settings.gradle` to point to the modules you added
    - [ ] Update `dependencies.gradle` and respective `build.gradle` files to make sure dependencies are hooked up and compiling properly
- [ ] Remove the sample modules `app` and `lib`.
- [ ] Modify `CHANGELOG.md` to reflect the version of your initial release.
- [ ] Update this `README.md` file to reflect your project.
    - [ ] Delete everything above including these checkboxes

# Project Name ![Build Status](https://github.com/uber/android-template/workflows/CI/badge.svg)

Replace this text with a synopsis of the library.

## Motivation

Explain why this library exists and what problems it solves.

## Download

Include instructions on how to integrate the library into your projects. For instance install in your build.gradle:

```
dependencies {
  annotationProcessor 'com.uber:annotation-processor:0.0.1'
  implementation 'com.uber:library:0.0.1'
}
```

## Usage

Provide instructions on how to use and integrate the library into a project.

If there's some special pieces for testing (ie Mocks) explain those here as well.

## License

Copyright (C) 2017 Uber Technologies

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.