Skip to content

Poornimagaurav/delphinium

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Recommended Initial Setup

Prerequisites

  1. If you are setting up a localhost development environment install a *AMP stack on your computer, otherwise have a server with an *AMP stack installed
  • Mac: MAMP
  • Windows: WAMP or XAMPP
  • Linux: Follow this guide 2. Download OctoberCMS 3. Create an octobercms database
    • Go to either localhost:8888 or localhost and open phpMyAdmin, if you used MAMP, WAMP, or XAMPP
    • Click the "Databases" tab
    • Under the "Create a database" section, create a database named octobercms. Don't worry about setting the collation.

Setup

  1. Before cloning this repository, go to your server root and create a delphinium folder.
  • Your server root will be www under WAMP or htdocs under MAMP/XAMPP 2. Copy the installation files from OctoberCMS into /delphinium 3. Depending on your setup, either go to localhost:8888/delphinium/install.php or localhost/delphinium/install.php then follow the installation wizard. 4. After getting to the database section, set the database as octobercms then set the MySQL login information. If this is a fresh install, you'll most likely have these settings:

    • Port: 3306
    • Username: root
    • Password: root
    1. Go to the Administrator section and setup your admin information.
    • Do not forget this! There's no way to retrieve your admin login information if you lose it.
    1. Finish the installation then try going to /delphinium/backend and login with your admin account to make sure everything is setup.
    2. Now go to this Url and follow the instructions on how to create a fork. You'll want to create the following directory pathToDelphinium/plugins/delphinium and create your fork here.
    3. After that, you'll need to install all the plugins. Open a command line and do the following:
    cd /path/to/delphinium
    php artisan october:up
    1. OctoberCMS moved its guzzle vendor folder (as well as all other vendor files) to a new plugin. You will need to add the October.Drivers plugin in order for Roots to work. In order to do this go to the backend-->Settings-->Updates and click on "Install Plugins". In the search box type "October.Drivers" and install the plugin.
    2. Install the minimal layout from here https://github.com/ProjectDelphinium/minimized_layout

Congratulations! Your app should be up and running.

Enabling development mode

  1. Go to The Canvas website (uvu.instructure.com). Go to the DEV_MGMT course and select “Guzzle” from the left menu. Click “Log in" when you get the message. Now from the left navigation menu select "Settings". In the new page select "Student View" from the right hand menu. Go back to the Guzzle page.
  2. Copy your userId, Token, and everything else you see on the page somewhere safe.
  3. Update your app with the latest code from GitHub.
  4. Run the following command from your cmd line:
  • php artisan october:up
  1. In your backend app go to Greenhouse/Dev. Add a new Dev Configuration (enter your UserId, Token, CourseId, Domain, and select “Enable for dev mode”). Save your changes
  2. Now in your development environment whenever you are going to request data from Roots you’ll need to drop the “dev/Dev” component in your page first. To configure it just select the “Dev Configuration” you just created from the drop down. Then drop any other component you are going to be working on (this only applies for components that make data calls to Roots).

Troubleshooting

When I see the OctoberCMS demo page, the style is all messed up and there's a bunch of 404 errors.

Your mod_rewrite module is probably disabled. Look for your apache installation (under WAMP it will be /path/to/wamp/bin/apache/apacheX.X.X) then under the conf folder you'll find httpd.conf. Search for this line: #LoadModule rewrite_module modules/mod_rewrite.so then remove the #. Restart your server.

I'm getting an error saying it can't connect to the database.

Check under app/config/database.php and make sure the MySQL database information is correct.

When I try to run the php artisan october:up command, it says it cannot find php.

Make sure the directory that contains php.exe is in your PATH variable.

Right after I open the app, I see an exception saying that octobercms.cache does not exist.

You'll need to create a cache table. Open phpMyAdmin and go to the octobercms database. Click the "Operations" tab then under the "Create table" section create a cache table with 3 columns. The 3 columns are:

  1. key * Type: VARCHAR * Length: ~500 (doesn't matter too much) * Index: UNIQUE
  2. value * Type: TEXT
  3. expiration * Type: INT
After updating my repository I get a database error

{"error":{"type":"Illuminate\Database\QueryException","message":"SQLSTATE[42S02]: Base table or view not found: 1146 Table 'myTable' doesn't exist....

Run php artisan october:up. This will create the table you are missing in your local OctoberCMS app

When I try to use Roots I get the following error:

Class 'GuzzleHttp\Client' not found

You need to go to the octoberCms backend and install the plugin October.Drivers

When I add a new component to a page nothing works!

Most of the components depend on a series of javascript libraries. In order for everything to work you must add a layout to the page where you're dropping the component. This layout is found [here] (https://raw.githubusercontent.com/ProjectDelphinium/minimized_layout/master/minimal.htm). Follow the readme.md on [this] (https://github.com/ProjectDelphinium/minimized_layout) repo to know where you need to add this layout.

When I add the test-roots component or try running certain Roots functions I get an error:

Class 'GuzzleHttp\Psr7\Request' not found October.Drivers comes with an older version of Guzzle than the one we need. To fix this error find the composer.json file inside delphinium/plugins/october/drivers and change this line

guzzlehttp/guzzle": "XXX"

to this

guzzlehttp/guzzle": "~6.0"

Then, if you haven't installed composer, go ahead and install it. Then go to the plugins/october/drivers directory and run the following composer command: composer update

You should now be able to run the test-roots component and other Roots functions.

About

Project Delphinium- a Laravel & OctoberCMS-based Gamification framework

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 63.5%
  • JavaScript 17.7%
  • HTML 12.6%
  • CSS 6.2%