Skip to content
Snippets Groups Projects

Project Management

Last edited by Ivan Sanchez Milara

Theory and tutorials

GIT:

Introduction:

Basic commands:

  1. Provide initial configuration git config --global user.name "John Doe" git config --global user.email "ivan.sanchez@oulu.fi"
  2. Download the repo from the remote repository to your computer (creating a local repository). You just need to do this once: git clone url
  3. Move updates (generally made by others) from remote repo to your local repo: git pull origin master
  4. Store changes that you have done in your local repo: git add . git commit -m “message”`
  5. Move updates from local repo to remote repo: git push origin master

GITIGNORE

Sometimes you have files that you do not want to include in the repo: eg. .DS_STORE in Mac, or executables (.exe, .class …). In that case, you can add a .gitignore file (a text file with name .gitignore) to the root of your repo.

Tutorials:

I recommend use gitignore, specially for people who is using MAC. Gitlab has some templates for .gitignore (add file/gitignore)

Interactive tutorials

Other tutorials

SSH keys in gitlab:

  • Gitlab Is a cloud application in which you can create git repositories (among other multiple things): https://gitlab.fabcloud.org
  • You need to generate a pair of public/private key to identify yourself with the gitlab server:

Some links:

Workflow:

  1. In Windows open the GIT BASH CMD. In Linux/Mac: open the terminal
  2. Type the command ssh-keygen -t rsa -C "your.email@example.com" -b 4096
  3. The pair of public/private key is stored in: your_home_directory/.ssh
    • id_rsa -> Private key
    • id_rsa.pub -> Public key
  4. Open the Public key (id_rsa.pub) with a text editor and copy its content in https://gitlab.fabcloud.org/-/profile/keys

Debugging:

If you have problems you can debug how your system access your key values using: ssh -vvT git@gitlab.fabcloud.org

NOTE REGARDING BIG FILES

YOU MUST NOT BIG FILES TO THE REPO: Files bigger than few MB are problematic. You need to compress images so it occupies ~100-200 KB MAXIMUM (average would be ~20 – 50 KB) and resolutions: 800x600; 1024x768; If you need some more detail you can make it bigger (example a screenshot with small letter).

You can list the size of the files BEFORE SENDING TO THE REPO using the following command in the terminal (Use GIT BASH CMD in Windows) du -s * | sort -rn

COMMON MISTAKES (NEIL’s PRESENTATION):

  • key path, permissions

chmod go-rwx ~/.ssh/key_name

  • archive size

    ~MB/person/week

  • check before commit

du -s * | sort -rn

  • compress, resize pictures for Web

convert

  • link to external videos
  • pull and merge before pushing, never force
  • refresh browser after editing page

HANDLING IMAGES

Markdown

Markdown is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML.Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor (from Wikipedia)

Static web generator

Best static site generators to start with:

Removing files

  • If you want to remove all the files that are in your repo:
git rm -r .
git commit -m "Removed all files"
git push origin master

Documentation content

Project page

  • Give a short description of the project
    • What is the system functionality?
    • Why do you want to build this project?
  • Include a picture showing your system (just a sketch drawn on a paper would be enough)

About me page

  • Description of who you are
    • Background
    • Past project (if any)
    • Why are you doing Fab Academy

Week 1 assignment

  • Link to the tutorial that you have follow in order to learn GIT

    • Explain the problems you face while following the tutorial and how you solved them.
    • What did you learn out of this tutorial.

  • Explain in detail how you created the public/private key and how did you uploaded it to gitlab

    • Include screenshots

  • Explain the GIT workflow: clone - pull -- add -- commit -- push

    • Explain what each command do.

  • Explain in detail how did you upload your first version of the website to gitlab

    • Include screenshots
    • Do not forget to tell if you modified any configuration file (yml)
      • Why is this configuration file necessary?
    • Do not forget to mention where did you get your clone URL

  • Explain how did you create the website

    • If you used a web static generator application, give some short information about it.
    • Tell which template/theme did you use
    • Show which configuration files you modified
    • If you modified the layout show in a picture what would you like to be your final layout
    • Explain briefly which files did you modified to change the layout / functionality of the site
      • E.g. css, javascript, md
    • Tell which editor did you used to modify the files
    • If you used web static generator tell which extensions and plugins did you use.
      • Tell how you modified configuration files.
    • INCLUDE SCREENSHOTS OF THE PROCESS

  • Do not forget to mention where you found problems and how you solved them

    • PROCESS DOCUMENTATION NOT TUTORIAL LIKE DOCUMENTATION

Miscellanea

  • Do not forget to upload the agreement signed
  • Acknowledge pictures/other material you took from internet. Be sure you have the right permissions to use them.
  • Remember to have adequate resolution for the web. Each image should occupy ~10-50 KB

Additional resources: