Portfolio website
All your work will not be documented in Word, Google Drive, Facebook Messenger or on paper, but on your own portfolio website! This is a great way to show off your work and is integrated in your project.
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 IoT: Git.
- Go to your Gitlab-project by visiting https://gitlab.fdmci.hva.nl and clicking on 'IoT [your name]'.
- On the left side of the page, click on 'Deploy' > 'Pages'.
- Look for 'Access pages', here should be a link to your portfolio website.
Updating your Portfolio Website
Your Portfolio 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 Portfolio Website will be updated automatically.
It may take a few minutes before your changes are visible on your Portfolio Website.
Running your Portfolio Website locally
If you have to commit and push every change before you can see it on your Portfolio Website, it may be a good idea to run your Portfolio Website locally. This can be easily done by following the next steps:
- Make sure you have cloned the project following the instruction on the IoT: Git 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) Portfolio Website
mkdocs serve
. - If everything went well, you should be able to visit your (local) Portfolio Website by browsing to: http://127.0.0.1:8000.
- Every time you make a change in your 'docs'-folder, your (local) Portfolio Website will be updated automatically.