We have decided to stop the maintenance of this public GitHub repository.
Kaleidoscope is a browser-based application that provides structured information about projects. The solution’s key benefits are a clear and easy to use user interface, an attractive and touch-enabled user experience and valuable features like combined filtering, full-text search & integrated feedback forms.
On an overview screen the user can browse the full portfolio of projects displayed as colored bubbles. Each bubble represents one project. The color of the bubbles can be related to the main filter criterion. Using different filter dimensions, it is possible to narrow down the number of projects to those of interest.
By clicking on a bubble found interesting, the user can jump to the detail page of the project. Each project detail page is structured the similarly. All content can be maintained in the WordPress content management system that serves as the backend of the solution. The project detail page starts with an individual header picture, including the project name and short catch phrase to get the user’s attention. Each following section, e.g. at a glance, key project information and sections for further detailed project information, can be adjusted by configuration in the WordPress backend.
In this section, you will find basic installation instructions. Please see our detailed Installation Guide and the additional files in this directory that will be needed during the installation procedure.
The next steps are based on the assumption that there is a Linux server or virtual machine in place running a Ubuntu (or Debian) installation and being able to login to the machine via SSH (or direct console) with a user having SUDO permissions.
The following packages need to be installed:
- PHP (>=5.6)
- Apache 2
- MySQL
- npm
- nodejs
- webpack
You can use the following command line commands to install those applications and libraries:
# sudo add-apt-repository -y ppa:ondrej/php
# sudo apt-get update
# sudo apt-get -y upgrade
# sudo apt-get -y install apache2 libapache2-mod-php5.6 php5.6-gd php5.6-imagick php5.6-curl php5.6-mysql mysql-server git npm nodejs-legacy
# npm install --global webpack
You would also need to configure Apache modules as follows:
# sudo a2dismod mpm_event
# sudo a2enmod rewrite php5.6
Most probably it is also a good idea to enable mod_ssl and configure it with the appropriate certificates that are validate within your organization's network.
Set memory limit, post limit, and max upload size to a value that supports the upload of large files to wordpress.
sudo sed -i.orig 's/upload_max_filesize\ \=\ 2M/upload_max_filesize\ \=\ 512M/g' /etc/php/5.6/apache2/php.ini
sudo sed -i.orig 's/post_max_size\ \=\ 8M/post_max_size\ \=\ 512M/g' /etc/php/5.6/apache2/php.ini
sudo sed -i.orig 's/memory_limit\ \=\ 128M/memory_limit\ \=\ 768M/g' /etc/php/5.6/apache2/php.ini
Download wordpress installation files from e.g. https://wordpress.org/latest.tar.gz. Untargz this under /var/www/html. If Apache/PHP/MySQL is running as expected, you will now be able to install wordpress using their web-interface. It will guide you through the process.
Once wordpress is installed, access the backend http://hostname/wp-admin and go to the plugins page. Make sure the plugins listed below are installed. You will need to purchase a license for Advanced Custom Fields Pro.
When ACF pro is installed, use file "acf-export-xxxx-xx-xx.json" to upload and import the field descriptions.
Using the Custom Post Type UI plugin, you will need to create a new post type "portfolio". This can be done in the wordpress backend under CPT UI -> Add new post type. When this has been successfully created, a new entry "Portfolio" in the navigation bar shows up, where you can now start to enter project data.
Get Sources from github.com/SAP/wordpress-kaleidoscope and check them out into /var/www/html/wp-content/themes/kaleidoscope (or your wordpress directory that you choose). Run webpack in this directory.
cd /var/www/html/wp-content/themes
git clone https://github.com/SAP/wordpress-kaleidoscope.git kaleidoscope
cd kaleidoscope
webpack
Depending on your host system, some additional steps may be necessary. When everything is set up correctly, you will see Kaleidoscope serving the projects you defined in wordpress under http(s)://hostname/.
You will need to set a couple of options in the theme settings (Appareance -> Theme Config) in order to have it up and running including filters. As a first starting point in this repository there is a snapshot of the Theme Config page included, which can be a starting point for your custom Kaleidoscope page.
If you need any support, have any question or have found a bug, please report it in the GitHub bug tracking system.
Copyright (c) 2017 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file.