🧑‍💻 CoDoc

CoDoc is a desktop app for students in SoC (School of Computing) to connect with each other for the benefit of their course of study. It is optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, CoDoc can get your contact management tasks done faster than traditional GUI apps and networking with people can be easily done.

🚀 Installation

To install CoDoc, follow these steps:

1. Ensure that you have downloaded the latest version of CoDoc under Releases in GitHub.
2. Copy the jar file into an empty folder.
3. Open a command window in that folder.
4. Run the command java -jar CoDoc-{version}.jar e.g., java -jar CoDoc-v1.2.jar (i.e., run the command in the same folder as the jar file).

🕹️ Usage

Use the available commands to manage your contacts and connect with students in SoC.

Command summary

Action	Format, Examples
Add	add n/NAME y/YEAR c/COURSE e/EMAIL [g/GITHUB] [l/LINKEDIN] [m/YEARTAKEN MODCODE]... [s/SKILL]... e.g., add n/Bob Sim y/2 c/2 e/[email protected] g/bobby l/linkedin.com/in/bom-sim-086g93847/ m/ay2223s2 cs2103t m/ay2223s2 cs2101 s/python s/java
View contact	view INDEX e.g., view 3
View tab	view C/M/T e.g., view c, view m or view t
Edit	edit [n/NAME] [y/YEAR] [c/COURSE] [e/EMAIL] [g/GITHUB] [l/LINKEDIN] [m/MODINDEX YEARTAKEN MODCODE]... [s/SKILL]... e.g., edit n/Bob Lim m/2 ay2223s2 cs2109s
Find name	find NAME [MORENAMES] e.g., find Bob Sam Pete
Find module	find m/ MODCODE [MOREMODCODES] e.g., find m/cs2013t cs2109s cs2107
Find skills	find s/ SKILL [MORESKILLS] e.g., find s/java python
List	view the default list of all contacts
Delete	delete INDEX e.g., delete 3
Clear all contacts	clear
Help	help

• Words in UPPERCASE are the parameters to be supplied by the user.
  e.g. in add n/NAME, NAME is a parameter which can be used as add n/Bob Sim.
• Items in square brackets are optional.
  e.g., n/NAME [s/SKILL] can be used as n/Bob Sim s/python or as n/Bob Sim.
• Items with … after them can be used multiple times including zero times.
  e.g., [s/SKILL]… can be used as (i.e. 0 times), s/java, s/java s/python etc.
• To execute View tab or Edit command, a contact must be loaded up at the side, these commands target the current person loaded.
• Parameters can be in any order.
  e.g. if the command specifies n/NAME y/YEAR c/COURSE, y/YEAR c/COURSE n/NAME is also acceptable.
• If a parameter is expected only once in the command but you specified it multiple times, only the last occurrence of the parameter will be taken.
  e.g. if you specify c/com eng c/bza, only c/com eng will be taken.
• Extraneous parameters for commands that do not take in parameters (such as list, clear, help and exit) will be ignored.
  e.g. if the command specifies help 123, it will be interpreted as help.
• 💾 CoDoc data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.

For more detailed usage instructions, check out our User Guide.

🤝 Contributing

We welcome contributions to CoDoc! To contribute, follow these steps:

1. Fork the CoDoc repository to your own GitHub account.
2. Create a new branch for your changes.
3. Make your changes and submit a pull request.

For the detailed documentation of this project, check out our Developer Guide.

🙌 Contributors

CoDoc is developed and maintained by the following team of students from the School of Computing, National University of Singapore:

• An Cheng Yang @anchengyang
• Darie Chan Rong Zhi @NappySprout
• Nam Harin @harin0826
• Tan Wei Shwin, Linus @linustws
• Yip-Au Hew Kit, Shawn @ShawnYip-Au

👋 Thank you for choosing CoDoc! We hope you find it useful and enjoyable to use.

This project is based on the AddressBook-Level3 project created by the SE-EDU initiative.