@datacamp/mobile-teach

DataCamp for Mobile for Teachers

This executable will help you build courses for DataCamp for Mobile.

Installing

You can install this executable by running the command npm install -g @datacamp/mobile-teach

Using

Help

The executable has some help build in. To check it run mobile-teach help or mobile-teach help [command], e.g. mobile-teach help preview.

Preview

Run mobile-teach preview [path-to-lesson] to preview a lesson. E.g. mobile-teach preview ./chapter1/lesson1.yml. Then visit http://localhost:8080 in your browser.

Check

Run mobile-teach check somewhere in the course directory to check if the content is following the guidelines.

Version

• To check the version of the executable, run mobile-teach version.
• To update the executable, run npm update -g @datacamp/mobile-teach.
• To check if you have the latest version of the executable, run npm outdated -g @datacamp/mobile-teach (if nothing appears and the command just exits, you have the latest version).

Flashcards

• When making changes to flashcards, make sure to use yarn install --force to force re-download of all packages. This makes sure that the changes made in the /frontend part of the repo are also present in the /teach part. Do this every time you change something in the /frontend part of the repo that has to be reflected in here.
• To try out changes to flashcards locally, cd to /teach and use the yarn link command, then cd to /backend and use the yarn link @datacamp/mobile-teach command. Now the backend will use your local bundle.
• To "deploy" flashcards, first use yarn publish, then bump the version of @datacamp/mobile-teach in /backend/package.json, and deploy the backend the usual way