The Coffee Can Cafe

JCU Cairns, 2019 SP1, CP3402 A2, Team 10

Authors

• Matthew Livingston
• Ady (Ye Thiha Aung)
• Yvan Burrie
• Anthony Vincin
• Stephen Ohl

Server

• Domain: notdotcom.fun
• Address: 139.162.34.109
• Ubuntu 18.04
• Apache 2.4.29
• MySQL 5.7.25
• PHP 7.2.15

Workflow

• Development:
  • PhpStorm
• Collaboration:
  • Slack
  • GitHub
  • Slack + Github Integration
  • Trello: Using GitHub projects as of 9th of May (see below)...
  • Github Projects
• Deployment:
  • Git: via command line, PhpStorm VCS, GitHub Desktop, etc...
  • Github webhook
  • Our own utility

WordPress

• Version: 5.1.1
• Themes:
  • Understrap
• Production Site
  • Database name: prod
• Staging Site
  • Database name: staging

Theme Installation

• Install Wordpress (v5.1.1) according to the installation instructions here
• Extract the theme archive into {WORDPRESS_FOLDER}/wp-content/themes/
• Log into WordPress as the user created during the installation
• From the admin sidebar, select Appearance, then Themes
• Select the theme called "Canned" and click the Activate button
• Ensure all required plugins are installed (as alerted in plugin panel).
• Congratulations, you have installed the theme!

Development Continuation

• Edit work/configurations.ini with correct credentials/details.
• Go to work/index.php.
• Go to Deploy and then select your local developer.
• Finally, use the tools at your disposal: Git push/pull, DB import/export, etc.
• Upon pushing to Github, if the webhook is active, the server should handle the request.

Development on Server

• Issue the following commands to clone the github repository into your development environment's wordpress installation

  • Change into the wp-content/themes directory
    • cd /wp-content/
  • Create an empty git repository
    • git init
  • Set the github repository as a remote repository
    • git remote add origin https://github.com/cp3402-students/a2-cp3402-2019-team10
  • Retrieve the remote repository data into git
    • git fetch
  • Reset the git repository to a known status
    • git reset origin/master
  • re-create the files from the repository data
    • git checkout .
  • Define the target of the push command
    • git push --set-upstream origin master
  • Add to the file .git/info/exclude any filenames you do not want included in the repository

• On your development server (be it WAMPP, Vagrant or other), any time you make a change to files under the git repository,

  • Add all modified and newly-created files to the next commit
    • git add .
  • Commit and push your recent changes
    • git commit -m "Useful commit message"
    • git push

Deployment on Server

• Log in to your_username@cp3402.notdotcom.fun via SSH.
• Run the command cp3402deploy which performs the following:
  • Changes to the staging site's wp-content/themes/ directory.
  • Performs a git pull to sync the local repository with the version stored on github.
  • Prints a message containing the URL of the site.

test change - push from phpstorm