Skip to content

Product website

All your work will not be documented in Word, Google Drive, Facebook Messenger or on paper, but on your own product website! This is a great way to show off your work and is integrated in your project.

In Smart Cities you will have two product websites:

  • In the Smart Cities Project: Here you can document the tile you are working on.
  • In the Smart Cities Group Project: Here you can document the group project product.

Portfolio Website URL

You can find your portfolio website following the next steps:

  • Make sure you have created a project following the instruction on the Studio Smart Cities: Git Repository.
  • Go to your Gitlab-project by visiting https://gitlab.fdmci.hva.nl and look for the project 'Smart Cities Project [your year] - [your name]'.
  • If everything was build correctly you should see a button on the right side of the Gitlab project called 'Gitlab pages', linking to your product website.

Updating your Portfolio Website

Your Product Website is build from Markdown-files inside your 'docs'-folder. You can find the 'docs'-folder in your Gitlab-project. Every time you make a change in here, commit and push your changes to Gitlab. Your Product Website will be updated automatically.

It may take a few minutes before your changes are visible on your Portfolio Website.

Running your Product Website locally

If you have to commit and push every change before you can see it on your Product Website, it may be a good idea to run your Product Website locally. This can be easily done by following the next steps:

  • Make sure you have cloned the project following the instruction on the Studio Smart Cities: Git Repository to your laptop.
  • Install Python 3.x on your laptop if you haven't already. You can download it from https://www.python.org/downloads/.
  • Open a bash-terminal and navigate to the root of your project.
  • Download the mdocotion folder with its content from your online repo using git submodule update --init --recursive
  • Run the following command to install all the requirements pip install -r requirements.txt.
  • Run the tools for the template: cd mdocotion && python setup.py install && cd ..
  • Run the following command to start your (local) Product Website mkdocs serve.
  • If everything went well, you should be able to visit your (local) Product Website by browsing to: http://127.0.0.1:8000.
  • Every time you make a change in your 'docs'-folder, your (local) Product Website will be updated automatically.