DeveloperGuide.adoc

Developer Guide

• Setting up
  • Prerequisites
  • Importing the project into IntelliJ
• Design
• Testing
• Appendix A: User Stories
• Appendix B: Use Cases
  • Use case: Delete person
• Appendix C: Non Functional Requirements
• Appendix D: Glossary

Setting up

Prerequisites

• JDK 8

• IntelliJ IDE

Importing the project into IntelliJ

1. Open IntelliJ (if you are not in the welcome screen, click File > Close Project to close the existing project dialog first)

2. Set up the correct JDK version

   1. Click Configure > Project Defaults > Project Structure

   2. If JDK 8 is listed in the drop down, select it. If it is not, click New…​ and select the directory where you installed JDK 8

   3. Click OK

3. Click Import Project

4. Locate the build.gradle file and select it. Click OK

5. Click Open as Project

6. Click OK to accept the default settings

7. Run the seedu.addressbook.Main class (right-click the Main class and click Run Main.main()) and try executing a few commands

8. Run all the tests (right-click the test folder, and click Run 'All Tests') and ensure that they pass

9. Open the StorageFile file and check for any code errors

   1. Due to an ongoing issue with some of the newer versions of IntelliJ, code errors may be detected even if the project can be built and run successfully

   2. To resolve this, place your cursor over any of the code section highlighted in red. Press ALT+ENTER, and select Add '--add-modules=java.xml.bind' to module compiler options

Design

Testing

• In IntelliJ, right-click on the test folder and choose Run 'All Tests'

Appendix A: User Stories

Priorities: High (must have) - * * *, Medium (nice to have) - * *, Low (unlikely to have) - *

Priority	As a …​	I want to …​	So that I can…​
* * *	new user	see usage instructions	refer to instructions when I forget how to use the App
* * *	user	add a new person
* * *	user	delete a person	remove entries that I no longer need
* * *	user	find a person by name	locate details of persons without having to go through the entire list
* *	user	hide private contact details by default	minimize chance of someone else seeing them by accident
*	user with many persons in the address book	sort persons by name	locate a person easily

Appendix B: Use Cases

(For all use cases below, the System is the AddressBook and the Actor is the user, unless specified otherwise)

Use case: Delete person

MSS

1. User requests to list persons

2. AddressBook shows a list of persons

3. User requests to delete a specific person in the list

4. AddressBook deletes the person.

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

Appendix C: Non Functional Requirements

1. Should work on any mainstream OS as long as it has Java 8 installed.

2. Should be able to hold up to 1000 persons.

3. Should come with automated unit tests and open source code.

4. Should favor DOS style commands over Unix-style commands.

Appendix D: Glossary

Mainstream OS

Windows, Linux, Unix, OS-X

Private contact detail

A contact detail that is not meant to be shared with others.