hugo-blog/content/posts/leopold.md

+++ draft = false date = 2020-02-01T18:54:46Z title = "Marc Leopold Photography" description = "Developing a portfolio website using October CMS and Vue.js." tags = ["October CMS", "Vue", "CMS"] categories = ["Portfolio"] featured_image = "/images/leopold/large-1.jpg" series = ["Portfolio"] +++

Marc Leopold is an apocryphal photographer and visual artist based in Chicago, USA. He recently decided his previous (and rather imaginary) website, whose purpose was to showcase his work, was beginning to look dated.

He decided that it was time for a modern, up to date portfolio site.

Being a photographer's portfolio site, the requirements are fairly basic. Aside from the portfolio items, we just need some brief background information and an outline of the services provided along with a contact form.

The Front End

{{< figure src="/images/logos/vue.svg" alt="The Vue logo." class="icon-inline icon-right sm-order-rev svg" caption="For the front end of this project, I went with Vue.js — a fast, modern JavaScript framework used to create web interfaces."

}}

The site's content will mainly consist of examples of Marc's portfolio Photography. These are organised into a number of galleries. The main task of a visitor will be browsing and viewing these images.

I feel that using a Single Page Application will give a nice user experience whilst browsing and viewing the images.

The images will be dynamically loaded when required. There will be no need for full page reloads. We only need to update the required on-screen images. Instead, we can dynamically update page components to create a fast, responsive site.

The Back End

{{< figure src="/images/logos/october-icon.png" alt="The October Content Management System's icon." class="icon-inline sm-order-rev" caption="For the backend I decided to use October, a Content Management System, based on the Laravel framework, which is a popular, open source, PHP based framework."

}}

The major requirements of a backend for this type of project is to store and organise images.

It would be possible to create a fully bespoke image based CMS to handle these requirements. However, this would involve a considerable amount of work and a lot of considerations, such as security best practices, browser compatibility, testing of code, etc.

Fortunately, there are already a number of actively developed libraries and frameworks available that have already solved these issues:

• they have the advantage of being tried and tested with real world use by many users,
• using one of these shortens development time considerably,
• we are able to build upon and extend functionality rather than reimplementing these features from scratch.

So for a relatively basic CMS, in which there are no particularly special requirements, it makes perfect sense to make use of a pre-existing platform. In this case, I chose October for a number for reasons.

{{< figure class="cheat-october-list" src="" alt="TODO - do properly with shortcode"

}}

• Performant

  October isn't bloated with unneeded functionality.

  It instead provides a base in which features and functionality may be added if required. This makes it faster than some alternatives, such as WordPress for example, which can suffer from having a large amount of features included as a base.
  It also has useful default features such as minification of CSS and JavaScript. The templating engine, Twig, generates static HTML, giving the speed benefits of a static site, without database lookups.

• Developer Oriented

  October is targeted towards developers.

  High quality documentation and a clean and modern codebase makes it easy to extend and add functionality.
  Plugins are entirely separate - they have their own database and namespaces preventing conflicts between them.
  The templating system and text file based website structure allows for separation of data and presentation and gives easy version control management.

• Community

  There is a large developer community.

  This means a large number of plugins and themes provided by the community.
  Not as many as WordPress but many of the WordPress plugins can be considered to be poor quality, particularly among the free ones. It can also be difficult to extend WordPress plugins.

• Secure

  Relatively secure when compared to alternatives like WordPress.

  There is a single point of entry into the application, with only one file that can ever be accessed, index.php, reducing the potential attack area.
  There is also more rigorous approval process for plugins and themes, that with some alternative platforms. Each one must undergo a strict verification progress.

• Customisation

  It is simple and straight forward to customise the administrative interface.

  This is very useful for a site that will involve a lot of users with the ability to manage their accounts and decreases development time substantially.

So, these reasons are why, in this case, I consider a platform like October to be better for building a backend CMS than, for example, WordPress. It is easier to customise and add the required functionality without the inherent bloat of some alternatives.

Having said that, it may sound like WordPress just isn't very good. Not when compared to something like October. This, however, I don't feel to be true.

{{< figure src="/images/logos/wp-logo.png" alt="The WordPress icon." class="icon-inline sm-order-rev wp-icon" caption="WordPress is very good at what it actually is -- a platform that allows users, who may have limited technical ability, to publish a website. For this it is very successful, after all it powers over 30% of the world's websites."

}}

However, it is also a victim of its own success.

It is a very high profile target with a lot of effort expended in finding exploits and vulnerabilities. Combined with its start as a blogging platform, with CMS features bolted on over time, this can make leaner, more focused alternatives more appealing to developers.

The Design

As the primary purpose of the site was to display a portfolio of images, then naturally the focus should be on those images.

I felt that having striking, interesting images on the home page would create interest. Interest that would engage visitors and encourage exploration of the site further.

The site has a colour scheme that is intentionally, lacking colour and fairly dark. This is to draw the attention of visitors to the full colour photographs that are intended to be the focus of attention.

The Deployment

The website is hosted on a Virtual Private Server using Docker.

The main advantage of using Docker containers in this case, is in how it simplifies development and deployment.

Using containers ensures the development environment is identical to the deployment environment.

The Dockerised services we require, are simple to set up and having these services isolated in containers, we eliminate any issues caused by conflicting services or other aspects of the environment.

Deployment is also simplified in that the containers can be easily pushed to production servers.

{{< figure src="/images/logos/docker-vertical-monochromatic.png" alt="The Docker logo." class="logo large"

}}