galennursing/omeka repository overview

⁠GEARS - Galen Exam Analysis and Review System

GEARS is the Galen Exam Analysis and Review System. This project is intended to centralize the primary exams for all Galen campuses in order that analysis and reporting may be done across the college.

⁠Pre-Requisites

GEARS is developed for a PHP stack.

• PHP > 7.0
• MySQL > 5.5 or PostgreSQL > 9.0
• Apache 2.0 or another webserver with PHP bindings

GEARS also takes advantage of the following managers which must also be installed

• Composer (PHP Packagement Management)
• Bower (Web debendency management)
• GIT (Repository and version management)

⁠Installation

Once the dependences are installing, use the following proceedure to install GEARS

• Clone the GEARS repository to the web server
  • git clone [email protected]:GalenCollege/Test-Item-Bank.git [directory]
• Run composer and bower
  • composer update
  • bower update
• Create database / connection user on database service
  • The user will need all priviliges on the schema if using GEARS to create the tables and insert initial data.

⁠Configuration

After the repository is cloned and dependencies updated, the config file needs to be created and apache configured.

⁠Config file

• Copy [app]/config/app.default.php to [app]/config/app.php and configure for your environment specifically the following areas:
  • Debug mode
    • Development: set to true
    • Production: set to false
  • App.gtm
    • Set to the google tag manager id
  • Security.salt
    • Specify a random salt value for encryption
  • Datasources.default
    • Specify the database settings for your environment
  • Canvas
    • Specify values for connecting with Canvas

⁠Apache Config

The following configurations are needed in Apache. If you are using another server, use the corresponding configuration.

• DocumentRoot

  [app]/webroot
  

  Copy

• The Directory directive should be set to the following

  <Directory "[app]/webroot">
    Options Indexes FollowSymLinks
    AllowOverride All
  </Directory>
  

  Copy

  ⁠Initial Database Population

  The database needs to be seeded with default data in order to be used. Run the following command to seed the database.

  [app]/bin/cake upgrade

  This command will create the database tables needed for GEARS as well as seed the database with the necessary lookup data and admin user credentials.

  ⁠Dummy Data (Optional)

  You may optionally seed the database further which will configure quizzes and questions for each course.

  [app]/bin/cake DummyData DummyData

  This command will create quizzes, questions, and answers for every course within GEARS.

  ⁠Logging In

  Navigate to the server url. Use the following credentials to log in.

  User Name: Admin

  Password: Password123

  You can change the password from the users workflow.

  ⁠LDAP Authentication (Optional)

  You can configure GEARS to use LDAP for authentication. The following settings in [app]/config/app.php will help you connect to your LDAP or Active Directory.

  • Auth.ldap.enabled = true

  • Auth.ldap.config.base_dn The root where LDAP searches should be made. Consists of the form dc=example,dc=com

  • Auth.ldap.config.account_suffix

  • Auth.ldap.config.domain_controllers

    Comma separated list of servers / domain controllers to connect to

  • Auth.ldap.config.use_ssl

    if use_tls = true then use_ssl should be false

  • Auth.ldap.config.use_tls

    if use_ssl = true then use_tls should be false

  • Auth.ldap.config.port