Skip to content

Setup GitLab

Make sure that you Form a Project Team before proceeding.

This step will create your team’s project space in GitLab, where you will store project documents, issues, and source code.

Steps

Step 1: Use the New-Project Wizard

The first step need to be to create a project in GitLab using the built-in wizard.

  1. Open the GitLab home page.
  2. Select + > New project/repository > Create Blank Project.
  3. Fill in the form:
    • The project should be placed under the Username of one of your team members (e.g. j2avery in the example).
    • Visibility should remain Private.
    • Your project should have a descriptive name e.g., UberTweets1.
  1. Select Create project to proceed.
Create Project

Step 2: Set project security

It’s important that you set permissions on your project. This provides access to those who need it, while preventing others from accessing it! The person who sets up the project should make the following changes:

  1. Check project visibility.
    • Settings > General > Visibility Level
    • Ensure that it’s set to Private.
Visibility Flag

  1. Add your teammates to the project with full access.

    • Manage > Members, Invite Members.
    • When they accept, change their role to Owner.

  2. Add the instructor(s) to your project as Developer(s) 2.

    • Manage > Members, Invite Members, and use details from the contact page.
TAs aren’t assigned to teams until after this deliverable, but they will need access to your project too! Make sure to go back and add them as a Developer once details are posted on the Demos page.

Step 3: Customize your project (optional)

If desired, you can also add a project icon, and a description.

  • Settings > General, Project Avatar.
  • Settings > General, Project Description.

Step 4. Getting a working copy from GitLab

Next, we’re going to add some documents to your project’s Git repository. To do this, you need a working copy of your repository:

Open the web page for your GitLab project. Click on the Code button, and copy the URL from Clone with HTTPS.

GitLab

In a terminal, on your computer, cd to the location where you want to keep your source code. git clone the URL.

$ git clone https://git.uwaterloo.ca/cs346/public/mm.git

In this example, we would have a folder named mm that contains the contents of the Git repository.

Step 5: Add README file

You should create a file in the root of your source tree named README.md. This will be displayed by default when users browse your project and serves as the main landing page for your project.

Add the following details to get started.

  • Project name
  • Project description (1-2 sentence description)
  • Team member names and contact info

Include the team roles and team contract from the form a team instructions.

See deliverables for details on what to include in your README.md.

Step 6. Push changes to the repository

Once you have confirmed that your project is working, you can commit and push the changes.

$ git add *
$ git commit -m "Initial commit"
$ git push

Step 7. Submit your project.

When you have completed the steps above, please submit for grading.

Login to Learn, navigate to Submit > Dropbox > Project Setup, and submit a link to your top-level project page from GitLab. This is important, since it’s the only way we have of easily locating your repository!

Note that only one person on the team needs to submit this link. This is a team dropbox, so everyone will be credited with the submission.

  1. It’s easy to change your name later, so you’re not stuck with this name! ↩︎

  2. This is really important! The instructor need access to your project to setup Learn and other systems. Your TA needs access later to grade your deliverables. ↩︎