Start Here

...if this is your first time using the cli tool. The intent is that you can follow this guide top-to-bottom to get your tenant created, configured, and used by your app code.

These commands are viewable in the docs with additional details.

Confirm Your Version of Node

v10.x is officially supported, and you will get errors if you're using a lower version. Managing your versions with nvm is recommended.

nvm list
            v8.12.0
    ->     v10.16.0
             system
    default -> 8.12.0 (-> v8.12.0)
    lts/carbon -> v8.16.0 (-> N/A)
    lts/dubnium -> v10.16.0

Login

Run madcloud login and enter your username and password when prompted.

Example (? are prompts. your input is on new lines) :

$ madcloud login
? Enter your email 
    [email protected]
? Enter your password 
    ***********
We have sent you an email. Please copy and paste the code to complete login.
? Enter verification code 
    abcdefg-hijkl-mnop-qrstuvw-xyz123
Welcome [email protected]!

If you've forgotten your password since you last used it, there's a description here under Password Reset. Alternatively, you can ask a Platform Admin on the #platform-support Slack channel to reset your password for you. Once your password is reset, login with the cli command as described above.

Make a Sandbox

If you are making any appConfig or endpoint changes to support you concierge-associate code changes

1. clone the URBN implementation repo : git clone [email protected]:madmobile/impl-urban.git
2. if you have a ticket to do work that will requires changes to the underlying appconfig or endpoints run git checkout -b feature-ticket-number
   • the actual sandbox won't be created until you push those changes if you created it locally
   • you'll get an email when the sandbox is created named feature-ticket-number

Forward slashes in the branch name will be converted to -'s for the sandbox name, so naming it with dashes consistently may reduce confusion.

Clone Permissions

Clone the permissions from the develop branch to your branch: madcloud sandbox-migrate develop feature-ticket-number

feature-ticket-number is your sandbox name (with the dash, not forward slash)

That should tell you the permissions were cloned if you do it right

Example :

$ madcloud sandbox-migrate develop feature-ticket-number
Sandbox "develop" has been migrated to "feature-ticket-number"

Create an env File

Run madcloud new env to create a file env/feature-ticket-number.env.json and copy the contents of the env file of the branch you branched from. This will usually be either a env/release.env.json file or env/develop.env.json file.

git push your changes

Serve Your Local Appconfig for Use with the App

Run npm run serve to serve your data directory to mock device settings, and the appconfig.json available from the config endpoint. This will make your appConfig changes available immediately without requiring a push to the repository. Endpoint changes will need to be pushed to the repository and successfully deployed in order to be used.

Where To Go From Here

• more thorough details here, including branching strategies: https://docs.google.com/document/d/1pnVfHuMvNU3y0RCNRMTZHdxuNq7dHxpSKT2cR1oJoEU
• the official documentation for all commands and options : https://docs.madcloud.io/sections/cli-tool/
• start changing your endpoints as described in the docs Endpoint Run & Endpoint Test
• Read the reference impl docs to see workflows https://docs.madcloud.io/sections/cli-tool/reference-impl/