INSTALL.md

Introduction

• The Adapt authoring tool is a node app that provides a user interface for the Adapt framework.
• This version of instructions contains only the essential details. A more detailed set of installation instructions is also available. If you need assistance troubleshooting, consult the Adapt community's Technical Discussion Forum.
• As an alternative to this manual installation, the Adapt authoring tool may be installed on VirtualBox with Vagrant. Please reference Install with Vagrant.

##To Install Manually

###1. Install Prerequisites

Install the following before proceeding:

• Git
• Node Use Node.js v4.2.x. Node version managers, such as nodist (Windows) or [nvm (OS X, Linux)] (https://github.com/creationix/nvm), make it easy to switch between versions of Node.
• npm is bundled and installed automatically with Node.
• Grunt
• Adapt-CLI
• MongoDB

The following are optional:

• FFmpeg is used to provide thumbnails for image and video assets.
• Robomongo is not used by the authoring tool, but you might find it helpful in your work with MongoDB.

Tips:

• Windows users should run these commands in Git Bash if Git was installed using default settings. Otherwise, run the command prompt window as Administrator.
• 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. Clone the Adapt_Authoring Project

git clone https://github.com/adaptlearning/adapt_authoring.git

###3. Install Dependencies Navigate to the folder where you cloned adapt_authoring and run the following command: npm install

###4. Run the Install Script

The final portion of the install script will help you configure the authoring tool. Most configuration questions will appear with a default answer already in place. And most times you can just accept the default values by pressing the Enter key. The only input you are required to provide are an email address and password for the super user account. (The questions about the super user account is not the same as the SMTP service or the master tenant.) The super user's email address and password will be used to login to the authoring tool.

Notes:

• FFmpeg is not used by default. When the question "Will ffmpeg be used?" N for no will appear as the default. If FFmpeg is installed and you want to use it, type Y before pressing the Enter key.
• In the future the authoring tool will be able to send notifications via e-mail. Configuration questions will ask about SMTP service, SMTP username, SMTP password, and Sender email address. Because this is not yet functioning, your responses have no impact. Accept the default of "none" for the SMTP service and leave the others blank.
• It is essential that you verify that the MongoDB service has started and is running. Installation will fail if the MongoDB service has stopped.

Run the following command. node install

If the script succeeds, you'll receive the following message: Done, without errors. And you'll be instructed to Run the command 'node server' (or 'foreman start' if using heroku toolbelt) to start your instance.

###5. Run the Application

1. Verify MongoDB service is running.

2. Run the following command. node server As the server starts, it will report in the terminal: Server started listening on port 5000 If your server is listening on a different port, take note of it.

3. Open a browser and in the address bar type: localhost:5000 (If your server is listening on a different port, substitute your port for 5000.)

When the login page appears, enter the super user's e-mail address and password.