Install the Test Package

Introduction

The [Adapt-CLI](/adaptlearning/adapt_framework/wiki/Adapt Command Line Interface) provides a command for creating a course. Because the command installs the latest public release of the Adapt framework it cannot be used to install this test package. Manual installation is required.

##Installation Overview

1. Install prerequisites.
   Installation of the Adapt framework depends on Node, Git, Grunt, and the Adapt-CLI.

2. Download the test package.
   Download the source code from its repository on GitHub.

3. Install module dependencies.
   Use npm and adapt to install required packages and plug-ins.

4. Run the sample course.
   Build the supplied sample course and start a server.

---

##1. Install Prerequisites

Install the following before proceeding:

• Git
• Node.js
• grunt-cli
• adapt-cli

Tips:

• To verify if a requirement is already installed, check for its version.
• Windows users should run these commands in Git Bash if Git was installed using default settings.
• Mac and Linux users may need to prefix the commands with sudo or give yourself elevated permissions on the /usr/local directory as documented here.

##2. Download the Test Package.

Download the test package as a ZIP and extract the files. (If you are a Windows user, you may need to unblock the ZIP archive before you extract it.)

Open a console interface (e.g. Git Bash, Terminal on OSX, Powershell or CMD.exe) and navigate to the extracted folder adapt-test-package-master (you can safely rename this).

##3. Install Module Dependencies.

The extracted folder contains two versions of the test-package: 'rtl' and 'standard'. Navigate into one as your current working directory and run the following command.
npm install

This will install all of the package dependencies of the test framework. Be patient. If any error occurs, read the output. Determine if a dependency failed to install properly, if you forgot to install one of the prerequisites, or if you require elevated permissions. If you need assistance troubleshooting, consult the Adapt community's Technical Discussion Forum. If this command completes successfully, run the following command.
adapt install

This will download the v2.0 compatible plug-ins to the correct locations in the framework.

##4. Run the Sample Course

Build the included sample course by running the following command:
grunt build

Start a server by running the following command:
grunt server

To view the course, open a browser to the following URL: http://localhost:9001/
To terminate the server, press ctrl+c .