Skip to content

PlenumUW/plenum-contenta

Repository files navigation

Plenum is an online journal devoted to showcasing the highest quality scholarship in undergraduate geography while building community amongst the Geography Department at the University of Washington. It is managed, produced, and reviewed by undergraduate students from the Department of Geography at the UW.

Plenum Website Back-End

Plenum's back-end is a custom Contenta CMS, an open-source and API-first distribution of Drupal 8. This back-end is used to manage Plenum content and expose the content via a JSON API, which is then accessed via the front-end website.

alt text

Local Install

Requirements

  • Github Account - Sign up for the student developer pack for freebies
  • Access to Plenum's Dev Team Google Drive - Contact plenum@uw.edu with your uw email to get access
  • A LAMPy software stack - MAMP is a great solution
  • Global install of PHP - For easy installation and management, checkout Homebrew(Mac) or Chocolatey(Windows)
  • Global install of Composer - It is a package manager, like NPM, but for php. Use Chocolatey or Homebrew for easiest installation.

Getting Setup

  1. Clone this repo into the hosted directory of your LAMPy stack (/MAMP/htdocs/)
  2. Install project dependencies with Composer, this will take a few minutes... During installation, go to step 3
cd /plenum-contenta
composer install
  1. Within MySQL create a new database--name it 'contenta' and choose the 'utf8mb4_unicode_ci' collation.
  2. Create a file titled .env at the root directory of the project and input the following and replace '{{VARIABLES}}' with relevant information. If you're using MAMP, this replacement information can be found at the 'WebStart' page.
# Example .env file.
SITE_MAIL=admin@localhost
ACCOUNT_MAIL=admin@localhost
SITE_NAME='Plenum Contenta - Local'
ACCOUNT_NAME=admin
MYSQL_DATABASE=contenta
MYSQL_HOSTNAME=localhost
MYSQL_PORT={{MYSQL_PORT}}
MYSQL_USER={{MYSQL_USER}}}}
  1. Create a file titled '.env.local' at the root directory of the project and input the following and replace {{VARIABLES}} with relevant information. If you're using MAMP, this info can be found at the 'WebStart' page.
# Example .env file.
MYSQL_PASSWORD='{{MYSQL_PASSWORD}}'
ACCOUNT_PASS=admin
  1. Run composer install:with-mysql and wait a few minutes to finish installing
  2. Once install is finished, change the site UUID
drush config-set "system.site" uuid dc6a60d1-2b77-4068-aebb-03aaca963536
  1. Uninstall included content.
    1. In browser, navigate to the CMS. Something like 'http://localhost:8888/plenum-contenta/web'
    2. Sign in with U:'admin' P:'admin', or whatever you put in the '.env' files for ACCOUNT_... variables
    3. Go to Advanced -> Extend -> Uninstall
    4. Uninstall 'Recipes Magazin'. This is a sample content module that comes with Contenta CMS.
  2. Import Plenum content
    1. Download Plenum Backup GZIP
    2. In the CMS, navigate to Configuration -> Development -> Backup & Migrate
    3. Import the downloaded backup
      • Sign back in if you get signed out following a successful import
    4. Download the public files
    5. Unzip the public files in the local directory ../plenum-contenta/web/sites/default/files/

Congratz! You are ready to develop!

About

The back-end for the Plenum website--Contenta CMS, an API-first distribution of Drupal 8.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •