Week 2 [Mon, Aug 17th] - Project

iP:

  1. Learn about the project
  2. Set up prerequisites
  3. Set up the project on your computer
  4. Add Increment: Level-0

iP

If you encounter any problem while doing the project, please post in the forum so that we can take the necessary action. We did significant changes to the individual project (iP) and the team project (tP) this semester. Hence, teething issues are a possibility.

We discourage you from doing project tasks allocated to future weeks, although it is fine to stay ahead of the schedule a bit (but no more than a week ahead).
Reasons: To help you gain and better simulate real projects, we want the project work to be over a longer period, rather than done as a short burst.

Reminder: As stated in the iP grading criteria, some increments need to be done each week. Clumping all the iP work into a short burst will not earn you full marks.

Please follow instructions closely. Any deviations can cause our grading scripts to miss your work (and result in you not getting credit for it).

Deadline:

Note the typical deadline for weekly project tasks:

But as there are no tutorials this week, you have until the next lecture to finish this week's iP tasks.

1 Learn about the project

  • Read the following two sections, if you haven't done so already:

Admin iP - Overview

Admin iP - Grading

2 Set up prerequisites

  • Ensure you have followed the Preparation sections of the following course tools:

Admin Programming Language

3 Set up the project on your computer

Read through this week's topics before starting the project.
If you encounter technical problems while doing the iP, follow the guidelines given below:

Admin Appendix D: Getting Help

Your GitHub username :  GitHub Avatar
Note: Type your GitHub username in the blank above so that we can customize sample commands to fit you.

  1. Fork https://github.com/NUS-CS2113-AY2627-S1/ip, while noting the points below:
    Keep the fork name as ip or else our grading scripts will not be able to detect it. You can change the fork name to something else after the semester (and the grading) is over e.g., after receiving your grade for the course.
    Keep the default branch name as master. While Git-Mastery uses main as the default branch name, iP and tP use master. As both these are used widely in the industry, it is good for you to be comfortable using both.
    Keep the source location as [project root]/src. Our grading scripts look for code in this folder.
    Uncheck the [ ] Copy the master branch only option so that you get a copy of the full repo.
  2. Enable the issue tracker of your fork (Go to Settings, scroll to the Features section, and select the Issues checkbox). Reason: At times we post feedback on your issue tracker.
    If the issue tracker is enabled, you should be able to visit the following URL: https://github.com/{your_user_name}/ip/issues/new
    e.g., https://github.com/[[username: JohnDoe]]/ip/issues/new
  3. Clone the fork onto your computer.
    Avoid putting Git-controlled files inside cloud-synced (e.g., OneDrive, Dropbox) folders. Reason: Multiple tools trying to detect/sync changes in the same folder can cause conflicts and unexpected behavior.
    If you want to access project files from multiple computers, use Git to do that (rather than cloud-syncing tools).
  4. Set up the project in your IDE as explained in the README file, if you plan to use an IDE for the project.
    Not willing to lose Vim power? If you are worried about losing access to powerful Vim features when using an IDE for the project, note that most IDEs have a Vim plugin (e.g., IdeaVim plugin) for using Vim features within the IDE. In other words, it is possible to access both IDE features and Vim features at the same time!
  5. Run Duke.java to verify that your project setup works.

4 Add Increment: Level-0

  • From this point onward, commit code at important points. Minimally, commit after completing each increment.
    Remember not to commit .class files and any other file that should not be revision-controlled.
Duke Level-0: Rename, Greet, Exit