A cloud service that enables Cordova and React Native developers to deploy mobile app updates directly to their users’ devices.

codepush cordova react react-native reactnative

Перейти к файлу

Richard Hua b99b877208 Update TROUBLESHOOTING.md		2016-10-06 09:43:26 -07:00
cli	Adding whoami image	2016-07-01 17:43:58 -07:00
definitions	Merge pull request #250 from Microsoft/app-deployment-names	2016-06-29 16:01:50 -07:00
gulp	added gulp task to clean cli and sdk	2015-12-03 11:37:05 -08:00
sdk	rename edit to patch	2016-06-07 11:49:04 -07:00
.gitignore	Snapshot initial scaffold	2015-09-30 14:18:53 -07:00
Gulpfile.js	Snapshot initial scaffold	2015-09-30 14:18:53 -07:00
LICENSE.md	rename all to CodePush	2015-10-13 17:51:26 -07:00
README.md	Updating with Code of Conduct info.	2016-06-22 12:05:42 -07:00
TROUBLESHOOTING.md	Update TROUBLESHOOTING.md	2016-10-06 09:43:26 -07:00
package.json	Freeze dts-generator version as they seem to have released a breaking change	2015-11-11 15:55:17 -08:00
tsconfig.json	Snapshot initial scaffold	2015-09-30 14:18:53 -07:00
tsd.json	Add update notifier library and support for npm cli update notification	2015-12-02 17:42:04 -08:00

README.md

CodePush

CodePush is a cloud service that enables Cordova and React Native developers to deploy mobile app updates directly to their users' devices. It works by acting as a central repository that developers can publish updates to (JS, HTML, CSS and images), and that apps can query for updates from (using provided client SDKs for Cordova and React Native). This allows you to have a more deterministic and direct engagement model with your userbase, when addressing bugs and/or adding small features that don't require you to re-build a binary and re-distribute it through the respective app stores.

This repo includes the management CLI and Node.js management SDK, which allows you to manage and automate the needs of your Cordova and React Native apps. To get started using CodePush, refer to our documentation, otherwise, read the following steps if you'd like to build/contribute to the project from source.

Dev Setup

Install Node.js
Install Git
Install Gulp: npm install -g gulp
Clone the Repository: git clone https://github.com/Microsoft/code-push.git

Building

Run npm install from the root of the repository.
Run gulp install to install the NPM dependencies of each module within the project.
Run gulp link to link CLI and SDK for local development. It is advisable to do this step if you are making changes to the SDK and want the CLI to pick those changes.
Run gulp build to build all of the modules. To build just one of the modules (e.g. cli or sdk), run gulp build-cli or gulp build-sdk.

Running Tests

To run all tests, run gulp test script from the root of the project.

To test just one of the projects (e.g. cli or sdk), run gulp test-cli or gulp test-sdk

Coding Conventions

Use double quotes for strings
Use four space tabs
Use camelCase for local variables and imported modules, PascalCase for types, and dash-case for file names

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.