2013-05-29 04:43:38 +08:00
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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
2013-10-22 10:55:40 +08:00
#
2013-05-29 04:43:38 +08:00
# http://www.apache.org/licenses/LICENSE-2.0
2013-10-22 10:55:40 +08:00
#
2013-05-29 04:43:38 +08:00
# 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.
#
-->
2016-03-11 18:35:14 +08:00
2015-02-19 10:37:59 +08:00
# Cordova Android
2011-08-19 09:21:51 +08:00
2020-04-15 11:40:59 +08:00
[![NPM ](https://nodei.co/npm/cordova-android.png )](https://nodei.co/npm/cordova-android/)
[![Node CI ](https://github.com/apache/cordova-android/workflows/Node%20CI/badge.svg?branch=master )](https://github.com/apache/cordova-android/actions?query=branch%3Amaster)
[![codecov.io ](https://codecov.io/github/apache/cordova-android/coverage.svg?branch=master )](https://codecov.io/github/apache/cordova-android?branch=master)
Cordova Android is an Android application library that allows for Cordova-based projects to be built for the Android Platform. Cordova based applications are, at the core, applications written with web technology: HTML, CSS and JavaScript.
2012-01-06 04:33:26 +08:00
2015-02-19 10:37:59 +08:00
[Apache Cordova ](https://cordova.apache.org ) is a project of The Apache Software Foundation (ASF).
2009-11-25 07:11:32 +08:00
2015-02-19 10:37:59 +08:00
## Requires
2011-08-19 09:21:51 +08:00
2020-04-01 11:55:47 +08:00
- Java JDK 1.8
2020-04-15 11:40:59 +08:00
- Android SDK [http://developer.android.com ](https://developer.android.com/ )
2013-10-22 10:55:40 +08:00
2015-02-19 10:37:59 +08:00
## Cordova Android Developer Tools
2010-01-27 09:58:27 +08:00
2015-02-19 10:37:59 +08:00
We recommend using the [Cordova command-line tool ](https://www.npmjs.com/package/cordova ) to create projects and be able to easily install plugins.
2011-09-02 05:44:02 +08:00
2015-02-19 10:37:59 +08:00
However, the following scripts can be used instead:
2010-08-31 07:02:47 +08:00
2013-10-22 10:55:40 +08:00
./bin/create [path package activity] ... creates the ./example app or a cordova android project
2013-07-16 02:27:05 +08:00
./bin/check_reqs ....................... checks that your environment is set up for cordova-android development
./bin/update [path] .................... updates an existing cordova-android project to the version of the framework
2011-09-02 05:44:02 +08:00
2013-07-16 02:27:05 +08:00
These commands live in a generated Cordova Android project. Any interactions with the emulator require you to have an AVD defined.
2011-08-19 13:40:09 +08:00
2013-07-16 02:27:05 +08:00
./cordova/clean ........................ cleans the project
./cordova/build ........................ calls `clean` then compiles the project
2013-10-22 10:55:40 +08:00
./cordova/log ........................ streams device or emulator logs to STDOUT
2013-07-16 02:27:05 +08:00
./cordova/run ........................ calls `build` then deploys to a connected Android device. If no Android device is detected, will launch an emulator and deploy to it.
./cordova/version ...................... returns the cordova-android version of the current project
2011-08-19 13:40:09 +08:00
2015-02-19 10:37:59 +08:00
## Using Android Studio
2010-08-31 07:02:47 +08:00
2015-02-19 10:37:59 +08:00
1. Create a project
2. Import it via "Non-Android Studio Project"
2017-05-26 02:54:25 +08:00
## Running the Native Tests
2020-04-15 11:40:59 +08:00
The `test/` directory in this project contains an Android test project that can be used to run different kinds of native tests. Check out the [README contained therein ](test/README.md ) for more details!