@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.

Lesson preview (legacy courses)

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).

Practice preview

• To preview practice exercises, use the "mobile preview" button in Teach app
• To try out changes to the practice preview app locally:
  • cd into the backend and run: yarn link ../teach
  • start the backend as usual, connected to production
  • open a practice pool in Teach app and open the preview for it
  • change the URL from https://mobile-api.datacamp.com to http://localhost:3000
  • every time you make changes, run: yarn build (from teach) and refresh the page in your browser
  • when you're done, cd into the backend again and run: yarn unlink ../teach
• To "deploy" the practice preview app:
  • update the version in package.json
  • run yarn npm publish
  • bump the version of @datacamp/mobile-teach in /backend/package.json
  • deploy the backend the usual way

Flashcards

• To preview flashcards, open https://mobile-api.datacamp.com/flashcards/ (don't forget the trailing /). Paste the flashcards YAML and click "Preview".
• To try out changes to the flashcards preview app locally:
  • cd into the backend and run: yarn link ../teach
  • start the backend as usual
  • open http://localhost:3000/flashcards/
  • every time you make changes, run: yarn build (from teach) and refresh the page in your browser
  • when you're done, cd into the backend again and run: yarn unlink ../teach
• To "deploy" the flashcards preview app:
  • update the version in package.json
  • run yarn npm publish
  • bump the version of @datacamp/mobile-teach in /backend/package.json
  • deploy the backend the usual way