Website

Keycube Website

Who create this website ?

Damien Brun, the creator of Keycube, wants to share his concept with as many people as possible, inspire the curious to discover the project, and build a community around Keycube. This community can be a driving force for new innovative ideas to develop the Keycube concept and turn it into a collaborative invention.

As a permanent professor at the Université du Québec à Chicoutimi, he presented his goals to his students and expressed his desire to promote Keycube through the website. This is how Nina Grignola and Lucie Augier joined the Keycube adventure.

Nina and Lucie are two aspiring creative engineers, in their final year of IMAC (Image, Multimedia, Audiovisual, Communication) training at the ESIEE Paris engineering school, and on an international exchange in Chicoutimi for the fall semester 2023. Both interested in design and web development, they seized the opportunity to continue developing their skills by participating in this original and innovative project.

Between October and December 2023, starting from scratch, they designed the graphic identity of Keycube, from the logo to the colors, typography, and finally, they prototyped and coded the website using the static site generator, Jekyll.

How to modify this website ?

Prerequisites

1. Ensure Jekyll is installed. If not, follow this tutorial.

2. Clone this repository.

3. Ensure you have the necessary rights to modify the repository.

4. Follow the instructions below.

All Pages working

All pages on the site have been automated. Easily add elements or information without diving into the code by following the information below.

About Page

To add a new contributors to the "About" page, follow these steps :

1. Navigate to the _data folder.
2. Open contributors.yml
3. Create a new item using the following format

- pseudo: New Contributor Pseudo
  image: 'link to contributor image (optional)'
  url: 'link provided by the contributor'

If the image is internal, maintain consistency by placing it in the "assets/img/contributors" folder with the filename "pseudo.jpg".

Blog Page

To add a new article to the blog, follow these steps :

1. Navigate to the _posts folder

2. Create a new markdown file using the following template

   File Name: YYYY-MM-DD-postname.markdown

---
layout: post  # Never change this layout; it defines the visual style of the post
title: "Title of the post"
date: YYYY-MM-DD HH:MM:SS +0200
author: Author(s)' names
categories:  # For now, only 4 categories have been created, but you can add as many as you want
  - Games
  - Tools
  - Divers
  - Others
image: "link to the image for the post"
resume: "Some sentence to summarize the post"  # This part will be shown on the blog page before clicking on the post
featuredPost: true  # Set to true if you want to highlight this post as a featured post
---

Research Page

To add a new contributors to the "About" page, follow these steps :

1. Navigate to the _data folder
2. Open research.yml
3. Create a new item using the following format

- date: Publication Date
  title: Research Title
  authors: Research Authors
  venue-journal: "Research Venue or Journal"
  url: 'link to read the research'

Software Page

1. Navigate to the _data folder
2. Open software.yml
3. Create a new item using the following format

- title: Software Project Title
  description: Project Description (350 characters max)
  key-features: Key Features (150 characters max)
  link: 'link to the GitHub repository'
  image: 'link to an image corresponding to the project'

Hardware Page

To add hardware projects, navigate to the "_data" folder and open "hardware.yml".

In this file, you'll find a list of hardware projects. To add a new project, use the following format:

- title: Hardware Project Title
  description: Project Description (350 characters max)
  key-features: Key Features (150 characters max)
  git-link: 'link to the GitHub repository'
  image: 'link to an image corresponding to the project'