Structure

This section describes the file structure of the RESCORM boilerplate.

File/Folder	Description
app	This folder contains the files of the React application.
app/assets	This folder contains the resources of the application (images, fonts, css files, ...)
app/assets/images	This folder contains the image files.
app/assets/scss	This folder contains the CSS and SASS files.
app/components	This folder contains the React components of the app.
app/components/ReduxProvider.jsx	It's the 'react-redux' provider component.
app/components/App.jsx	It's the main screen of the application.
app/components/FinishScreen.jsx	It's the screen shown to the user when finishing the app.
app/components/Header.jsx	It's a header that shows some basic information (progress measure, score, ...). It's intended for development purposes.
app/components/SCORM.jsx	It's a non-renderizable component that handles the connection and usage of the SCORM API.
app/components/Quiz.jsx	This component contains a full example of a Quiz build using the boilerplate. The rest of components (MCQuestion, MCQuestionChoice, QuestionButtons, ...) contained in the app/components folder belong to this example.
app/config/	This folder contains configuration files.
app/config/config.js	See the configuration section of the Wiki for details.
app/config/config_lms.js	See the configuration section of the Wiki for details.
app/config/locales.js	This file contains the text of the application in all available languages.
app/config/samples.js	This file defines a Quiz in JSON format to be loaded by the application.
app/constants/	This folder contains files that define constants.
app/constants/constants.jsx	This file defines constants for the application (e.g. initial state).
app/reducers	This file contains the actions and reducers of the React-Redux application.
app/reducers/actions.jsx	This file defines the actions of the application.
app/reducers/reducers.jsx	This file combines all the reducers of the application and defines its global state.
app/reducers/rnameReducer.jsx	This file defines the reducer called rname.
app/scorm	This folder contains different resources for loading and generating SCORM applications.
app/scorm/schemas	This folder contains all the required schemas to generate SCORM packages (versions 1.2 and 2004).
app/scorm/Local_API_1484_11.js	An API that mimics connectivity with SCORM 2004 compliant environments.
app/scorm/Local_API_SCORM_12.js	An API that mimics connectivity with SCORM 1.2 compliant environments.
app/scorm/SCORM_Player.js	A JavaScript library for loading SCORM applications.
app/scorm/imsmanifest_scorm12.xml	A template of a SCORM 1.2 XML Manifest. This template is used for packaging the React application into SCORM 1.2 packages.
app/scorm/imsmanifest_scorm2004.xml	A template of a SCORM 2004 XML Manifest. This template is used for packaging the React application into SCORM 2004 packages.
app/vendors	This folder contains useful libraries for the application.
app/vendors/I18n.js	Library that provides internationalization (i18n) support.
app/vendors/SCORM_API.js	Library that allows to stablish communication with SCORM 2004 and SCORM 1.2 compliant environments.
app/vendors/SCORM_API_Wrapper.js	A wrapper for the SCORM_API.js library in order to facilitate its usage by the React application.
app/vendors/Utils.js	A library with different utilities that can be used by the React application (e.g. a function to shuffle arrays).
app/index.html	The index.html file of the React application. Available at http://localhost:8080/index.html.
app/main.js	The main.js file of the React application.
app/scorm12.html	This file provides a SCORM 1.2 compliant environment for testing the application. Available at http://localhost:8080/scorm12.html.
app/scorm2004.html	This file provides a SCORM 2004 compliant environment for testing the application. Available at http://localhost:8080/scorm2004.html.
app/dist	This folder contains the production ready build of the application generated by the npm run production command.
app/dist_scorm	This folder contains the two SCORM packages (one compliant with SCORM 1.2 and the other one compliant with SCORM 2004) in which the production ready build of the application has been packaged as a result of the npm run scorm_package command.