Install & Update

Installation

1. Make sure you have node and npm installed. Install via nvm is highly recommended.
2. Install git
3. To install Udacimak, run:

npm install -g udacimak

For Windows users:

Udacimak uses youtube-dl to download Youtube videos. youtube-dl requires Microsoft Visual C++ 2010 Redistributable Package (x86) (see https://ytdl-org.github.io/youtube-dl/download.html). If you face errors regarding Youtube download while using Udacimak, install the package first to see if it resolves the issue.

Update

To update to the latest version, run the same install command:

npm install -g udacimak

Change Log

We do not generate change log files for this project.

But if desired, you can check changes in a new release by looking at the Git commit messages. The commit messages prior to a version number commit inform the changes that has been made to that version release.

For example, from the commit messages below, we know what changes have been made in version 1.1.1, 1.1.2 and 1.1.3

# version 1.1.3 example
afb3ade (tag: v1.1.3) 1.1.3
c0f7b4f Add user agent for requests
ad93fb3 Update README
fdb9b96 Add user agent for requests
129a9cd Add test setup

# version 1.1.2 example
597e727 (tag: v1.1.2) 1.1.2
1dc07e6 Update README
b9c4f2a Add case handle for wrong url in addHttp

# version 1.1.1 example
01f7308 (tag: v1.1.1) 1.1.1
03ab9ad Add handle case for wrong url in addHttp
19c4ae0 Add handle case for wrong url in addHttp
da55eef Update README
6346a68 Fix bug makeDir in CheckboxQuizAtom

Use Udacimak via Docker container

There is a Udacimak image that you can use. Download the image by running:

docker pull udacimak/udacimak

Udacimak is the entrypoint of the image so you can directly use it. Examples:

# show help
docker container run -it -v "$(pwd)/:/downloads" udacimak/udacimak --help

Remember to use volumes (-v) so that downloaded files are saved onto host machine.

You can also ssh into the container to directly work in their instead by changing entrypoint to /bin/bash:

docker container run --rm -it -v "$(pwd)/:/downloads" --entrypoint /bin/bash udacimak/udacimak

Remember to set the --targetdir option to the shared volume (eg. "downloads" in the examples above) so that downloaded or rendered contents are saved directly into the host machine, eg:

docker container run -it -v "$(pwd)/:/downloads" udacimak/udacimak render "downloads/_json/Front-End Web Developer Nanodegree nd001 v7.0.0" --targetdir "downloads"