National Puppy Menace

    material-remixer-remote-web

    1.0.0 • Public • Published

    Remixer Remote for Web

    Build Status npm version

    The Remixer variables defined in your app can be exposed on a remote controller website that you can set up using Firebase hosting. The remote controller allows updating your defined variables, and changes will be propagated in real-time across associated apps. Share the link to this site with your teammates from within the Remixer overlay or by emailing them.

    If you are interested in using Remixer on another platform, you may want to check out the iOS, Android, and JavaScript repos. You can use this Remote Controller with any of these three platforms to change the variables from a web dashboard.

    New to Remixer? Visit our main repo to get a full description of what it is and how it works.


    Quickstart

    1. Sign up for Firebase.

    Remixer remote will work with any new or existing Firebase account. It will use the Firebase Hosting feature to host this remote controller. If you don't have an existing Firebase account you wish to use, you can signup following instructions here.

    2. Use npm to install the necessary dependencies.

    # Run the following script from root of this repo 
    npm install

    3. Add your Firebase credentials.

    Add your Firebase credentials to the index.html file located in the src folder.

    // TODO: Replace with your project's info.
    var config = {
      apiKey: "<API_KEY>",
      authDomain: "<PROJECT_ID>.firebaseapp.com",
      databaseURL: "https://<DATABASE_NAME>.firebaseio.com",
    };

    4. Build and deploy the library to your Firebase Hosting account.

    Running the following script will generate a new public folder first with all of the required files. It will then copy these files to your Firebase Hosting storage.

    # Run the following script from root of this repo. 
    npm run deploy -- --project=<PROJECT_ID>

    5. Your site is now ready.

    The Remixer remote controller will now be available at:

    https://<PROJECT_ID>.firebaseapp.com/<REMOTE_ID>
    

    Contributing to Remixer Remote for Web

    We're excited you want to contribute to the project! Please read these docs so we can get your contributions submitted quickly.

    Is material-foundation affiliated with Google?

    Yes, the material-foundation organization is one of Google's new homes for tools and frameworks related to our Material Design system. Please check out our blog post Design is Never Done for more information regarding Material Design and how Remixer integrates with the system.

    License

    © Google, 2016. Licensed under an Apache-2 license.

    Install

    npm i material-remixer-remote-web

    DownloadsWeekly Downloads

    11

    Version

    1.0.0

    License

    Apache-2.0

    Last publish

    Collaborators

    • chriscox