From 82df9ee2fca1adcdc2103ddd36baddc4210ae1e7 Mon Sep 17 00:00:00 2001 From: Thomas Taylor Date: Fri, 13 Oct 2017 18:00:29 +0100 Subject: [PATCH 1/7] Add release notes --- CHANGELOG.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1ecee19005..d39ea72629 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,56 @@ This project adheres to [Semantic Versioning](http://semver.org/). **IMPORTANT**: For information on how to *correctly* update your installation, consult [INSTALL.md](https://github.com/adaptlearning/adapt_authoring/blob/master/INSTALL.md#updating-the-tool). +## [0.4.0] - 2017-10-16 + +### Upgrade Notes +Due to the changes made to the install script, this release restricts the installed framework version to `v2.x.x` to avoid unsupported breaking changes introduced in framework `v3`. + +Any custom code using `app:` prefixed events will stop working as of this release. Please check the release notes for more information (in most cases, simply changing the prefix to `origin:` will fix the issue). + +### Added +- Framework themes can now display a preview in the theme picker. To enable this, a `preview.jpg` file is needed in the theme folder root +- Can now specify custom auth source for MongoDB ([\#1673](https://github.com/adaptlearning/adapt_authoring/issues/1673)) +- Content pane added to app wrapper to act as a consistent container for main app content. Makes sure scrolling is consistent across the application among other things + +### Changed +- Major refactoring of the frontend folder: + - 'Core' code separated into modules, and core + - Web-app loading rewritten + - Core LESS files are now accessible without needing to specify a relative file path + - Editor routing code has been simplified, and moved into the sub-module folders. See [modules/editor/index.js#L27-L55](https://github.com/adaptlearning/adapt_authoring/blob/v0.4.0/frontend/src/modules/editor/index.js#L27-L55) for the routing code, and [modules/editor/article/index.js#L10](https://github.com/adaptlearning/adapt_authoring/blob/release-0.4.0/frontend/src/modules/editor/article/index.js#L10) as an example of the new routing method. + - Events using `app:` replaced with `origin:` for consistency. Most notably: any code using `app:dataReady` will need to be switched over to listen to `origin:dataReady` +- Install/upgrade scripts overhauled: + - Can now upgrade the server and framework to specific releases + - Can now upgrade the server and framework separately + - Install/upgrade scripts have been made prettier to look at (and more useful) with the introduction of activity spinners, and more helpful log messages + - Upgrade script now ignores draft and prereleases ([\#1723](https://github.com/adaptlearning/adapt_authoring/issues/1723)) + - Upgrade/install script now allows custom git repositories to be used for both the server and framework source + - Framework version can be restricted so as not to automatically upgrade to a version you don't want to support. To enable this, specify the `framework` version in `package.json` (accepts any valid semver range) ([\#1703](https://github.com/adaptlearning/adapt_authoring/issues/1703)) +- Besides the schemas, the user interface is now completely localised ([\#1573](https://github.com/adaptlearning/adapt_authoring/issues/1573)) +- Improved multi-user support for previewing/publishing of courses ([\#1220](https://github.com/adaptlearning/adapt_authoring/issues/1220)) +- User profile page is now correctly styled ([\#1413](https://github.com/adaptlearning/adapt_authoring/issues/1413)) +- Newly created courses can now be built without any editing ([\#1678](https://github.com/adaptlearning/adapt_authoring/issues/1678)) +- Must now input super admin password twice during install to avoid user error ([\#1032][https://github.com/adaptlearning/adapt_authoring/issues/1032]) +- Abstracted polyglot into the new internal `l10n` library (accessible globally via the `Origin` object). Language strings are now obtained using `Origin.l10n.t` +- Backbone forms version updated, and override code tidied up/removed where possible + +### Removed +- **Vagrant support has been dropped** ([\#1503](https://github.com/adaptlearning/adapt_authoring/issues/1503)) +- The user management's user list sort is now case-insensitive ([\#1549](https://github.com/adaptlearning/adapt_authoring/issues/1549)) +- Front-end tests removed for now + +### Fixed +- Framework plugin update has been fixed ([\#1415](https://github.com/adaptlearning/adapt_authoring/issues/1415)) +- Unused user password reset data is now cleared on delete of the related user ([\#1553](https://github.com/adaptlearning/adapt_authoring/issues/1553)) +- Copy and paste now correctly includes any extension settings ([\#1484](https://github.com/adaptlearning/adapt_authoring/issues/1484)) +- Dashboard no longer hangs if large images have been used as hero images ([\#1470](https://github.com/adaptlearning/adapt_authoring/issues/1470)) +- Server plugin schemas now correctly reflect the latest state after a plugin has been updated (previously a server restart was needed for any schema changes to be reflected) ([\#1524](https://github.com/adaptlearning/adapt_authoring/issues/1524)) +- Preview loading route added to prevent preview opening in a background tab/window ([\#1636](https://github.com/adaptlearning/adapt_authoring/issues/1636)) +- We now only attempt to load valid routes, avoiding unnecessary server breakdowns ([\#1534](https://github.com/adaptlearning/adapt_authoring/issues/1534)) +- Mocha tests fixed, and integrated with TravisCI +- Dragging is now restricted for components depending on layout ([\#1631](https://github.com/adaptlearning/adapt_authoring/issues/1631)) + ## [0.3.0] - 2017-01-24 ### Added @@ -292,6 +342,7 @@ If upgrading from a previous version, please add the following keys to your conf - Loading screen of death - Session cookie security issues +[0.4.0]: https://github.com/adaptlearning/adapt_authoring/compare/v0.3.0...v0.4.0 [0.3.0]: https://github.com/adaptlearning/adapt_authoring/compare/v0.2.2...v0.3.0 [0.2.2]: https://github.com/adaptlearning/adapt_authoring/compare/v0.2.1...v0.2.2 [0.2.1]: https://github.com/adaptlearning/adapt_authoring/compare/v0.2.0...v0.2.1 From 9c8dda684940804b23879e8a5970eb148fdaa4c0 Mon Sep 17 00:00:00 2001 From: Thomas Taylor Date: Fri, 13 Oct 2017 18:00:54 +0100 Subject: [PATCH 2/7] Fix formatting --- CHANGELOG.md | 62 ++++++++++++++++++++++++++-------------------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d39ea72629..243f826dbc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -77,7 +77,7 @@ Any custom code using `app:` prefixed events will stop working as of this releas - Removed `on_start` from notifications as Travis WebLint shows as deprecated ### Fixed -- Block alignment in page editor +- Block alignment in page editor - Password reset emails now work as intended - The 'enabled' checkbox in Plugin Management now hides plugins from editor - Removed tab/newline chars from CKEditor output to fix tabbing in published courses @@ -107,7 +107,7 @@ This is a patch release which fixes minor issues with v0.2.0 uncovered by commun - reset.less now loaded before *everything* ## [0.2.0] - 2016-07-27 -This version introduces a new look and feel to the user interface of the authoring tool, and closely matches the new theme of the Adapt community site introduced at the beginning of the year. +This version introduces a new look and feel to the user interface of the authoring tool, and closely matches the new theme of the Adapt community site introduced at the beginning of the year. In addition, this release also includes the following: @@ -126,7 +126,7 @@ This version contains numerous minor bug fixes and enhamcements, and supports th ### Added - Support for new Adapt Framework 'menu locking' functionality - Support for v2.0.9 of the Adapt Framework -- Support for _isAvailable flag +- Support for `_isAvailable` flag - Added link to GitHub repositories for plugins ### Changed @@ -137,9 +137,9 @@ This version contains numerous minor bug fixes and enhamcements, and supports th ### Fixed - Role statements not updated on a server restart - Autocomplete enabled on text input fields -- MongoStore does not support replicasets -- Removed @learningpool.com e-mail address hack - +- MongoStore does not support `replicasets` +- Removed `@learningpool.com` e-mail address hack + ## [0.1.6] - 2016-03-29 This version adds the ability to export the source code for a course that can be built using the Adapt Framework. It also fixes some important issues for installing using Vagrant. @@ -168,20 +168,20 @@ This version aligns closely with the re-work on the Adapt Framework v2.0.7 relea ### Added - Support for v2.0.7 of the Adapt Framework - Optimised build process, i.e. only plugins used are bundled -- Ability to copy the _id value of contentobjects, articles, blocks and components to clipboard +- Ability to copy the `_id` value of `contentobjects`, `articles`, `blocks` and `components` to clipboard - Ability to easily change component layouts without using drag and drop - Ability to export the source code of a particular course - Caching added to assets to improve performance ### Changed -- _isAvailableInEditor flag persisted when a new plugin is uploaded +- `_isAvailableInEditor` flag persisted when a new plugin is uploaded - Optimised performance of processing course assets in preview/download - Preview redirects to index.html rather than main.html - The count of failed logins is reset after a successful login -- Turned off automatic population of Display Title for blocks +- Turned off automatic population of display title for blocks ### Fixed -- Non-essential attributes removed from course.json +- Non-essential attributes removed from `course.json` - ACE JavaScript error when creating a new course - Hard 100kb limit on JSON payload - Corrected Project Details save issue @@ -199,20 +199,20 @@ This version adds support for Node.js v4.2.2 LTS. - Locking the Title and Display Title by default - Renamed 'Publish' button to 'Download' - Updated package dependencies to correct security issues -- Assets can now be defined in articles.json +- Assets can now be defined in `articles.json` - Tag length has been increased to 30 characters ### Fixed - Error on copying and pasting a block - Custom CSS/LESS not pulling through -- _supportedLayout not working correctly +- `_supportedLayout` not working correctly ## [0.1.3] - 2015-10-21 ### Added -- Support for MongoDB replicasets +- Support for MongoDB `replicasets` - More robust processing for missing schema pluginLocations -- Support for _accessibility added to Configuration Settings +- Support for `_accessibility` added to Configuration Settings - Support for screen breakpoints added to Configuration Settings - Added security to preview route @@ -221,24 +221,24 @@ This version adds support for Node.js v4.2.2 LTS. - Bumped CKEditor version to 4.5.4 ### Fixed -- Page and menu/sections were created without a linkText property set -- IE 9 issue with editor and list formatting -- Problem with isAssetExternal() +- Page and menu/sections were created without a `linkText` property set +- IE9 issue with editor and list formatting +- Problem with `isAssetExternal()` - Dashboard problems when a hero image is not set - Added validation for length of database name -- Added validation to Confugration Settings +- Added validation to Configuration Settings ## [0.1.2] - 2015-09-30 ### Added -- Support for _isOptional (Adapt Framework v2.x) +- Support for `_isOptional` (Adapt Framework v2.x) - Support for accessibility (Adapt Framework v2.x) - Support for plugin 'globals' (Adapt Framework v2.x) - Improved install/upgrade - 'Global' configurations for plugins are conditionally applied - Added basic browser-based spell-check to HTML editor - Table editing is now an option on the HTML editor -- Any tag added in the HTML editor is now preserved +- Any `` tag added in the HTML editor is now preserved - Support for 'Autofill' on graphic components - Confirmation when deleting a component/extension item, such as a narrative or question stem - Ability to delete assets @@ -246,12 +246,12 @@ This version adds support for Node.js v4.2.2 LTS. ### Changed - Course now has a Display Title property -- Default plugins are now taken from the framework adapt.json file, hard-coded references to plugins are +- Default plugins are now taken from the framework `adapt.json` file, hard-coded references to plugins are - Removed the dependency on adapt-cli - Added better logging for Validation Failed errors on database operations - Remove hard-coded references to core plugins -- Upgrade to Express 4, support NodeJS 0.12.6, i.e. removed hard dependency on 0.10.33 -- Any logger.log() calls now support placeholders properly +- Upgrade to Express 4, support NodeJS 0.12.6 (removed hard dependency on 0.10.33) +- Any `logger.log()` calls now support placeholders properly - Authoring tool specific properties now removed from output JSON - Updated logo @@ -268,7 +268,7 @@ This version adds support for Node.js v4.2.2 LTS. - Deleting an article or page does not remove associated assets contained with in - Modal overlay has a few responsive issues when appending content/custom editing views - Issue with long list item attribute values going outside of the list item box -- Issue with nested items in backbone forms showing as [object Object] +- Issue with nested items in backbone forms showing as `[object Object]` - Course tags were removed when a hero image was added or removed @@ -277,16 +277,16 @@ This version adds support for Node.js v4.2.2 LTS. ## Upgrade Notes If upgrading from a previous version, please add the following keys to your config.json -- "outputPlugin" - "adapt" -- "masterTenantName" - {name of the folder containing your master tenant files} -- "masterTenantID" - {MongoDB _id of the initial first row in the 'tenants' collection} +- `outputPlugin` -> `adapt` +- `masterTenantName` -> {name of the folder containing your master tenant files} +- `masterTenantID` - {MongoDB `_id` of the initial first row in the `tenants` collection} ### Added - Support for client-side configs - Proper support for shared courses - Poster images now available on courses - Progress indicator on preview -- Support for _trackingId values +- Support for `_trackingId` values ### Changed - Role permissions synced on a server restart @@ -294,7 +294,7 @@ If upgrading from a previous version, please add the following keys to your conf - Install process updated ### Fixed -- Minor IE 9 fixes +- Minor IE9 fixes - Corrected 'Back to courses' button - Missing language strings - Fixes around drag and drop, copy and paste @@ -327,7 +327,7 @@ If upgrading from a previous version, please add the following keys to your conf - Copy/paste moved to server-side - Content plugins preloaded on server boot - Asset records now use relative paths - + ### Removed - iframe previews - Sockets.io (for now...) @@ -337,7 +337,7 @@ If upgrading from a previous version, please add the following keys to your conf - Issue where project settings caused a javascript error - Issue with uploading gifs would fail - Issues with course duplication -- Issues with bowercache file locking +- Issues with `bowercache` file locking - Issues with drag and drop in page editor - Loading screen of death - Session cookie security issues From ddc705954ef29695763d0f5c69d8375a680d150b Mon Sep 17 00:00:00 2001 From: Tom Taylor Date: Tue, 17 Oct 2017 11:06:24 +0100 Subject: [PATCH 3/7] Update date --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 243f826dbc..6f762c63de 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). **IMPORTANT**: For information on how to *correctly* update your installation, consult [INSTALL.md](https://github.com/adaptlearning/adapt_authoring/blob/master/INSTALL.md#updating-the-tool). -## [0.4.0] - 2017-10-16 +## [0.4.0] - 2017-10-17 ### Upgrade Notes Due to the changes made to the install script, this release restricts the installed framework version to `v2.x.x` to avoid unsupported breaking changes introduced in framework `v3`. From dbd74460df3a75c8f096660142648fed2a4b249b Mon Sep 17 00:00:00 2001 From: Thomas Taylor Date: Tue, 17 Oct 2017 17:48:50 +0100 Subject: [PATCH 4/7] Update titles --- CHANGELOG.md | 34 ++++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 243f826dbc..c863990258 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [0.4.0] - 2017-10-16 +Major refactor of the front-end application. + ### Upgrade Notes Due to the changes made to the install script, this release restricts the installed framework version to `v2.x.x` to avoid unsupported breaking changes introduced in framework `v3`. @@ -56,6 +58,8 @@ Any custom code using `app:` prefixed events will stop working as of this releas ## [0.3.0] - 2017-01-24 +User management feature release. + ### Added - User management - Can add users @@ -86,6 +90,8 @@ Any custom code using `app:` prefixed events will stop working as of this releas ## [0.2.2] - 2016-09-13 +Bugfix release. + ### Added - Support for editing JSON objects, for example, the `_playerOptions` array in the Media component @@ -93,7 +99,8 @@ Any custom code using `app:` prefixed events will stop working as of this releas - Vagrant issue with preventing updating plugins ## [0.2.1] - 2016-08-16 -This is a patch release which fixes minor issues with v0.2.0 uncovered by community user testing. + +Bugfix release after community user testing. ### Added - LESS sourcemaps @@ -107,9 +114,8 @@ This is a patch release which fixes minor issues with v0.2.0 uncovered by commun - reset.less now loaded before *everything* ## [0.2.0] - 2016-07-27 -This version introduces a new look and feel to the user interface of the authoring tool, and closely matches the new theme of the Adapt community site introduced at the beginning of the year. -In addition, this release also includes the following: +Major theme update to match the new look and feel of [adaptlearning.org](www.adaptlearning.org). ### Changed - Disabled SSL certificate check during Vagrant install @@ -121,9 +127,10 @@ In addition, this release also includes the following: - Saving course settings hangs if nothing has been changed ## [0.1.7] - 2016-04-28 -This version contains numerous minor bug fixes and enhamcements, and supports the new menu locking feature released in version 2.0.9 of the Adapt Framework. - ### Added +Bugfix release to support framework v2.0.9. + +### Added - Support for new Adapt Framework 'menu locking' functionality - Support for v2.0.9 of the Adapt Framework - Support for `_isAvailable` flag @@ -141,7 +148,8 @@ This version contains numerous minor bug fixes and enhamcements, and supports th - Removed `@learningpool.com` e-mail address hack ## [0.1.6] - 2016-03-29 -This version adds the ability to export the source code for a course that can be built using the Adapt Framework. It also fixes some important issues for installing using Vagrant. + +Release to add source-code export of courses. ### Added - Support for new Adapt Framework 'start page' functionality @@ -163,7 +171,8 @@ This version adds the ability to export the source code for a course that can be - Intermittent error in copy and pasting component ## [0.1.5] - 2016-02-16 -This version aligns closely with the re-work on the Adapt Framework v2.0.7 release, with a focus on performance improvements around preview and downloading courses. + +Bugfix release to support framework v2.0.7. ### Added - Support for v2.0.7 of the Adapt Framework @@ -187,7 +196,8 @@ This version aligns closely with the re-work on the Adapt Framework v2.0.7 relea - Corrected Project Details save issue ## [0.1.4] - 2015-11-25 -This version adds support for Node.js v4.2.2 LTS. + +Release to add support for Node.js v4.2.2 LTS. ### Added - Support for Node.js v4.2.2 LTS @@ -209,6 +219,8 @@ This version adds support for Node.js v4.2.2 LTS. ## [0.1.3] - 2015-10-21 +Bugfix release. + ### Added - Support for MongoDB `replicasets` - More robust processing for missing schema pluginLocations @@ -230,6 +242,8 @@ This version adds support for Node.js v4.2.2 LTS. ## [0.1.2] - 2015-09-30 +Bugfix release. + ### Added - Support for `_isOptional` (Adapt Framework v2.x) - Support for accessibility (Adapt Framework v2.x) @@ -275,6 +289,8 @@ This version adds support for Node.js v4.2.2 LTS. ## [0.1.1] - 2015-03-12 +Large bugfix release. + ## Upgrade Notes If upgrading from a previous version, please add the following keys to your config.json - `outputPlugin` -> `adapt` @@ -306,6 +322,8 @@ If upgrading from a previous version, please add the following keys to your conf ## [0.1.0] - 2015-01-26 +Initial release. + ### Added - Support for menu selection - Support to load configuration from process.env From a0830a598e2e95573c2994f4c88a103525d95913 Mon Sep 17 00:00:00 2001 From: Thomas Taylor Date: Tue, 17 Oct 2017 17:52:18 +0100 Subject: [PATCH 5/7] Reword opening paragraph --- CHANGELOG.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c863990258..fd18ae7ae5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,10 @@ # Change Log -All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/). -**IMPORTANT**: For information on how to *correctly* update your installation, consult [INSTALL.md](https://github.com/adaptlearning/adapt_authoring/blob/master/INSTALL.md#updating-the-tool). +All notable changes to the Adapt authoring tool are documented in this file. + +**IMPORTANT**: For information on how to **correctly and safely** update your installation, please consult **INSTALL.md**. + +_Note that we adhere to the [semantic versioning](http://semver.org/) scheme for release numbering._ ## [0.4.0] - 2017-10-16 From 4d71ef1963edf59ad6cad9a51bc5eb4030166888 Mon Sep 17 00:00:00 2001 From: Thomas Taylor Date: Tue, 17 Oct 2017 17:53:04 +0100 Subject: [PATCH 6/7] Remove INSTALL.md content --- INSTALL.md | 82 ++---------------------------------------------------- 1 file changed, 2 insertions(+), 80 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 58acfc68d9..51c1f889c7 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,81 +1,3 @@ -## 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.](https://github.com/adaptlearning/adapt_authoring/wiki/Install-on-Server) If you need assistance troubleshooting, consult the Adapt community's Technical Discussion Forum. +# Installation -### Navigation -- [Installing Manually](#to-install-manually) -- [Updating the tool](#updating-the-tool) - -## To Install Manually - -### 1. Install Prerequisites - -Install the following before proceeding: -* [Git](http://git-scm.com/downloads) -* [Node](http://nodejs.org/) We recommend the [current LTS release](https://github.com/nodejs/LTS). Node version managers, such as [nodist (Windows)](https://github.com/marcelklehr/nodist) or [nvm (OS X, Linux)] (https://github.com/creationix/nvm), make it easy to switch between versions of Node. -* [npm](https://www.npmjs.com/) is bundled and installed automatically with Node. -* [Grunt](http://gruntjs.com/) -* [Adapt-CLI](https://github.com/adaptlearning/adapt-cli) -* [MongoDB](http://docs.mongodb.org/manual/) - -The following are optional: -* [FFmpeg](https://www.ffmpeg.org/index.html) is used to provide thumbnails for image and video assets. -* [Robomongo](http://robomongo.org/) 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](http://foohack.com/2010/08/intro-to-npm/#what_no_sudo). - -### 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.** - -## Updating the tool - -We've written a Node.js script to allow you to easily update both the authoring tool core and the installed Adapt framework to the latest versions. - -**IMPORTANT**: -- Before upgrading, make sure to first remove the `node_modules` folder and re-install the dependencies to ensure that you get the correct package dependencies for the updated code. -- Also please consult the [CHANGELOG](https://github.com/adaptlearning/adapt_authoring/blob/update-changelog/CHANGELOG.md) for the release you're upgrading to; any extra upgrade instructions will be noted here. - -```javascript -npm install --production -node upgrade -``` - -The upgrade script will ask for confirmation before proceeding. Once you've consented, the process will begin. +You can find detailed instructions for installing the Adapt authoring tool on the [repository's wiki](https://github.com/adaptlearning/adapt_authoring/wiki/Installing-the-Authoring-Tool). From 2c4a310bc1fb48114d5e7f900f6b68a74553cd9a Mon Sep 17 00:00:00 2001 From: Thomas Taylor Date: Tue, 17 Oct 2017 20:44:25 +0100 Subject: [PATCH 7/7] Add further changes --- CHANGELOG.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d080e04cd0..7780b1c05f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,20 +13,36 @@ Major refactor of the front-end application. ### Upgrade Notes Due to the changes made to the install script, this release restricts the installed framework version to `v2.x.x` to avoid unsupported breaking changes introduced in framework `v3`. -Any custom code using `app:` prefixed events will stop working as of this release. Please check the release notes for more information (in most cases, simply changing the prefix to `origin:` will fix the issue). +There are a few notable changes to the code that may impact customisations: +- `app:dataReady` has been renamed to `origin:dataReady` +- `variables.less` has been renamed to `colours.less`. +- Some editor collections have been renamed: + - `componentTypes` -> `componenttypes` + - `extensionTypes` -> `extensiontypes` + - `courseAssets` -> `courseassets` + +Please check the release notes below for more information. ### Added - Framework themes can now display a preview in the theme picker. To enable this, a `preview.jpg` file is needed in the theme folder root - Can now specify custom auth source for MongoDB ([\#1673](https://github.com/adaptlearning/adapt_authoring/issues/1673)) -- Content pane added to app wrapper to act as a consistent container for main app content. Makes sure scrolling is consistent across the application among other things +- New `contentPane` module takes over view rendering from `Router`, and acts as a consistent container for main app content. Makes sure scrolling is consistent across the application among other things. +- EditorDataLoader has been added to preload editor data. You can use the `EditorDataLoader.waitForLoad` function to halt code until preload has finished. You can also use the `editor:dataPreloaded` event. ### Changed - Major refactoring of the frontend folder: - 'Core' code separated into modules, and core - Web-app loading rewritten - - Core LESS files are now accessible without needing to specify a relative file path + - Core LESS files are now accessible without needing to specify a relative file path. `variables.less` has been renamed to `colours.less`. + - All duplicate LESS files have been merged, and put in their respective module folder + - The `adaptbuilder` folder has been renamed to `build` - Editor routing code has been simplified, and moved into the sub-module folders. See [modules/editor/index.js#L27-L55](https://github.com/adaptlearning/adapt_authoring/blob/v0.4.0/frontend/src/modules/editor/index.js#L27-L55) for the routing code, and [modules/editor/article/index.js#L10](https://github.com/adaptlearning/adapt_authoring/blob/release-0.4.0/frontend/src/modules/editor/article/index.js#L10) as an example of the new routing method. - Events using `app:` replaced with `origin:` for consistency. Most notably: any code using `app:dataReady` will need to be switched over to listen to `origin:dataReady` + - Router has been refactored, and the following convenience functions added: `navigateTo` - wrapper for `Backbone.Router.navigate`, `navigateToLogin`, `setHomeRoute` and `navigateToHome` + - Editor collections have been renamed to reflect the MongoDB collection names: `editor.componentTypes` -> `editor.componenttypes`, `editor.extensionTypes` -> `editor.extensiontypes`, `editor.courseAssets` -> `editor.courseassets` + - `window.polyglot` has been abstracted into the new localisation module, which can be referenced with `Origin.l10n` +- Dashboard module has been renamed to projects, and is the default home route +- User management has moved from plugins to modules - Install/upgrade scripts overhauled: - Can now upgrade the server and framework to specific releases - Can now upgrade the server and framework separately @@ -41,6 +57,7 @@ Any custom code using `app:` prefixed events will stop working as of this releas - Must now input super admin password twice during install to avoid user error ([\#1032][https://github.com/adaptlearning/adapt_authoring/issues/1032]) - Abstracted polyglot into the new internal `l10n` library (accessible globally via the `Origin` object). Language strings are now obtained using `Origin.l10n.t` - Backbone forms version updated, and override code tidied up/removed where possible +- Boolean selects are now rendered as checkboxes. ### Removed - **Vagrant support has been dropped** ([\#1503](https://github.com/adaptlearning/adapt_authoring/issues/1503))