Skip to content

Latest commit

 

History

History
86 lines (65 loc) · 4.9 KB

README.md

File metadata and controls

86 lines (65 loc) · 4.9 KB

TYPO3 Portfolio Extension

The portfolio extension is a versatile TYPO3 extension designed for developers, designers, photographers, and other creative professionals who wish to showcase their work through a portfolio website. This extension provides robust features including a variety of content elements, a sophisticated projects plugin, and extensive customization options.

Setup

In order to setup the extension you need to install the extension with composer or via the extension manager in TYPO3

  • composer req friendsoftypo3/theme-portfolio
  • add dependency to config.yaml
dependencies:
  - friendsoftypo3/theme-portfolio
  • ...

Content Elements

The portfolio provides a set of often used content elements for portfolio pages in order to present projects, skills, career path, etc on the portfolio website.

  • Introduction Card: The Introduction Card CE can be used on the homepage to present a quick teaser, an optional image and details to the information as well as a link to more details about yorself

  • Services: The Services CE allows a presentation of your services in a card style including a name and a short description for every service.

  • Resume: The Resume CE can be used for providing details about your career path and allows to add resume items for two categories (suggestion: education and work experience) including position, location, institution (school or company), description and a time period

  • Skill Display: The Skill Display CE allows presenting all skills you can provide including a name, description and a progress level for every skill. According to the progress level a progress bar can be shown, but this is optional.

  • Client Logos: The Client Logos CE can be used for listing client logos in a structured way to show for which companies or organisation you have already worked. Each client includes a logo and a title.

  • Project List: The project list displays all project from a specific folder (you need to create projects first in order to use this CE successfully). All projects are displayed in a simple list view. A project includes a title, description, optional one or more links and optional one or more images as well as an option if a detail page should be shown or not.

  • Project Teaser: The project teaser shows three projects from the listing and provides a link to the projects list.

Portfolio Styling & Sets Configuration

As soon as the setup is done, the portfolio can be adapted to your personal style and needs, this can be done by some basic configurations.

Example: Theme The portfolio provides two themes:

  • dark mode
  • light mode

You can change the theme in the settings with style.data.theme.

Sets Configuration

In the following table all options for the sets configration are shown.

Identifier Description Default Possible Options
style.theme For defining the base theme of the whole website and all content elements dark dark, light
style.primaryColor For defining the primary color used for buttons and links #ff854d all hex color values
style.secondaryColor For defining the hover color and accent elements #ff854d all hex color values
style.buttonBorderRadius For defining the corner styles of buttons, cards and icons none none, rounded, round
style.font Font family for the headline font Roboto Slab ...
style.copyFont Font family for the text font Roboto ...
style.contentAlignment Defining the content alignment center center, left
style.logo.path Defining the logo path in fileadmin /fileadmin/logo/typo3_logo.svg define the correct path

Socials

For adding links to your social media accounts you just need to add links to your accounts in the sets. The following social media channels are yet supported and can be shown with an icon.

Channel Identifier
Facebook socials.channels.facebook.link
Instagram socials.channels.instagram.link
Threads socials.channels.threads.link
Whatsapp socials.channels.whatsapp.link
YouTube socials.channels.youtube.link
Vimeo socials.channels.vimeo.link
Xing socials.channels.xing.link
Linkedin socials.channels.linkedin.link
Pinterest socials.channels.pinterest.link
Snapchat socials.channels.snapchat.link
TikTok socials.channels.tiktok.link
Reddit socials.channels.reddit.link
Xxxx socials.channels.x.link
Twitch socials.channels.twitch.link
tumblr socials.channels.tumblr.link
GitHub socials.channels.github.link

Development Setup

ddev start
ddev composer install
ddev exec .build/bin/typo3 setup