Giter Club home page Giter Club logo

code-push's Introduction

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 [email protected] with any additional questions or comments.

code-push's People

Contributors

agcolom avatar apolkingg8 avatar dlebu avatar dtivel avatar geof90 avatar hinzo avatar karllindmark avatar kerumen avatar kilihorse avatar lostintangent avatar mtunique avatar nurazem avatar patoroco avatar quentinyang avatar richardhuaaa avatar rmevans9 avatar rub8n avatar ryuyu avatar shishirx34 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.