Skip to content

Commit

Permalink
deploy: bc8f8ef
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Nov 12, 2024
1 parent 3f3bc40 commit 4f5e742
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion DeveloperGuide.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
Expected: The most recent window size and location is retained.</p></li></ol></li> <li><p>Resetting sample data</p> <ol><li><p>Open the folder where the <code class="hljs inline no-lang">WedLinker.jar</code> file is.</p></li> <li><p>Directly delete the <code class="hljs inline no-lang">data</code> folder in the same directory.</p></li> <li><p>Alternatively, open the <code class="hljs inline no-lang">data</code> folder and delete the <code class="hljs inline no-lang">addressbook.json</code> file stored there.</p></li> <li><p>Re-launch the app by entering <code class="hljs inline no-lang">java -jar WedLinker.jar</code> into the terminal again.<br>
Expected: Shows the GUI with a set of sample contacts, weddings, tasks, and tags.</p></li> <li><p>Refer to <a href="#saving-data">saving data</a> to understand how data is saved during operation.</p></li></ol></li></ol> <h3 id="quick-guide-to-prefixes-and-commands">Quick Guide to Prefixes and Commands<a href="#quick-guide-to-prefixes-and-commands" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <ol><li><p>WedLinker uses prefixes to parse the required fields for the commands.</p> <ul><li>name: <code class="hljs inline no-lang">n/</code></li> <li>phone: <code class="hljs inline no-lang">p/</code></li> <li>email: <code class="hljs inline no-lang">e/</code></li> <li>address: <code class="hljs inline no-lang">a/</code></li> <li>tag: <code class="hljs inline no-lang">t/</code></li> <li>date: <code class="hljs inline no-lang">d/</code></li> <li>task: <code class="hljs inline no-lang">tk/</code></li> <li>wedding: <code class="hljs inline no-lang">w/</code></li> <li>force: <code class="hljs inline no-lang">f/</code> <br></li></ul></li> <li><p>WedLinker has the following functions</p> <ul><li>find a person: <code class="hljs inline no-lang">find</code></li> <li>add a person: <code class="hljs inline no-lang">add</code></li> <li>delete a person: <code class="hljs inline no-lang">delete</code></li> <li>list all persons: <code class="hljs inline no-lang">list</code></li> <li>create a tag: <code class="hljs inline no-lang">create-tag</code> or <code class="hljs inline no-lang">ctag</code></li> <li>delete a tag: <code class="hljs inline no-lang">delete-tag</code> or <code class="hljs inline no-lang">dtag</code></li> <li>tag a person: <code class="hljs inline no-lang">tag</code></li> <li>untag a person: <code class="hljs inline no-lang">untag</code></li> <li>list all tags: <code class="hljs inline no-lang">list-tags</code> or <code class="hljs inline no-lang">ltags</code></li> <li>create a task: <code class="hljs inline no-lang">create-task</code> or <code class="hljs inline no-lang">ctask</code></li> <li>delete a task: <code class="hljs inline no-lang">delete-task</code> or <code class="hljs inline no-lang">dtask</code></li> <li>assign a task to a vendor: <code class="hljs inline no-lang">assign-task</code> or <code class="hljs inline no-lang">atask</code></li> <li>unassign a task from a vendor: <code class="hljs inline no-lang">unassign-task</code> or <code class="hljs inline no-lang">unatask</code></li> <li>mark a task as done: <code class="hljs inline no-lang">mark-task</code> or <code class="hljs inline no-lang">mtask</code></li> <li>unmark a task as done: <code class="hljs inline no-lang">unmark-task</code> or <code class="hljs inline no-lang">untask</code></li> <li>list all task: <code class="hljs inline no-lang">list-tasks</code> or <code class="hljs inline no-lang">ltasks</code></li> <li>assign a person as a vendor: <code class="hljs inline no-lang">assign-vendor</code> or <code class="hljs inline no-lang">asv</code></li> <li>unassign a person as a vendor: <code class="hljs inline no-lang">unassign-vendor</code> or <code class="hljs inline no-lang">uv</code></li> <li>create a wedding: <code class="hljs inline no-lang">create-wedding</code> or <code class="hljs inline no-lang">cw</code></li> <li>delete a wedding: <code class="hljs inline no-lang">delete-wedding</code> or <code class="hljs inline no-lang">dw</code></li> <li>assign a person to a wedding: <code class="hljs inline no-lang">assign-wedding</code> or <code class="hljs inline no-lang">asw</code></li> <li>unassign a person from a wedding: <code class="hljs inline no-lang">unassign-wedding</code> or <code class="hljs inline no-lang">uw</code></li> <li>edit a wedding: <code class="hljs inline no-lang">edit-wedding</code> or <code class="hljs inline no-lang">ew</code></li> <li>list all wedding: <code class="hljs inline no-lang">list-weddings</code> or <code class="hljs inline no-lang">lw</code></li></ul></li></ol> <div class="alert box-container alert-danger" data-v-474166ec><!----> <div class="header-and-body" data-v-474166ec><!----> <div class="box-body-wrapper" data-v-474166ec><div class="icon-wrapper" data-v-474166ec><i class="fas fa-flag" data-v-474166ec></i></div> <!----> <div class="contents" data-v-474166ec>
Note the difference between similar command shortcuts. 'untask' unmarks a task as done, while 'unatask' unassigns a task from a vendor.
Similarly, 'ltags' can be used to list all tags, while 'ltasks' can be used to list all tasks (note the plural for both commands, 'tags' and 'tasks').
Similarly, 'ltags' can be used to list all tags, while 'ltasks' can be used to list all tasks (note the plural for both commands, 'tags' and 'tasks').
</div> <!----></div></div></div> <br> <hr> <h3 id="person-features" class="features">Person Features<a href="#person-features" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <h4 id="finding-a-person">Finding a person<a href="#finding-a-person" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <div class="alert box-container seamless" data-v-474166ec><!----> <div class="header-and-body" data-v-474166ec><!----> <div class="box-body-wrapper" data-v-474166ec><div class="icon-wrapper text-info" data-v-474166ec><i class="fas fa-info" data-v-474166ec></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-474166ec></div> <div class="contents" data-v-474166ec><p data-v-474166ec><strong data-v-474166ec>Note:</strong> The guide for the find command will be based on the sample address book created on application launch, assuming no persons have been deleted. The commands can be similarly
applied to edited data, but specific expected results will differ. <br data-v-474166ec> <strong data-v-474166ec>Suggestion:</strong> Refer to User Guide for additional test cases, such as multiple prefixes or blank keywords.</p></div> <!----></div></div></div> <ol><li><p>Finding a person by name</p> <ol><li><p>Prerequisites: List all persons using the <code class="hljs inline no-lang">list</code> command. Multiple persons in the list. <br></p></li> <li><p>Test case: <code class="hljs inline no-lang">find n/alex</code> <br>
Expected: The contact <code class="hljs inline no-lang">Alex Yeoh</code> is shown in the <code class="hljs inline no-lang">Person</code> view. If this contact has been deleted and no other contacts whose
Expand Down
2 changes: 1 addition & 1 deletion DeveloperGuide.page-vue-render.js

Large diffs are not rendered by default.

Binary file modified images/Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
Search
</div> <ul class="dropdown-menu search-dropdown-menu dropdown-menu-hidden dropdown-menu-end" data-v-4f6e9aec></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-7c0fd418><!----> <!----></div></div></header> <div id="flex-body"><nav id="site-nav" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="fw-bold mb-2" style="font-size:1.25rem;" data-v-e6005420>Site Map</div></div> <div class="nav-component slim-scroll" data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/tp/index.html" data-v-e6005420>Home</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/tp/UserGuide.html" data-v-e6005420>User Guide</a> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/tp/UserGuide.html#quick-start" data-v-e6005420>Quick Start</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/tp/UserGuide.html#features" data-v-e6005420>Features</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/tp/UserGuide.html#command-summary" data-v-e6005420>Command Summary</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/tp/UserGuide.html#frequently-asked-questions" data-v-e6005420>FAQ</a></div></li></ul></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/tp/DeveloperGuide.html" data-v-e6005420>Developer Guide</a> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/tp/DeveloperGuide.html#acknowledgements" data-v-e6005420>Acknowledgements</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/tp/DeveloperGuide.html#setting-up-getting-started" data-v-e6005420>Setting Up</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/tp/DeveloperGuide.html#design" data-v-e6005420>Design</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/tp/DeveloperGuide.html#implementation" data-v-e6005420>Implementation</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/tp/DeveloperGuide.html#documentation-logging-testing-configuration-dev-ops" data-v-e6005420>Documentation, logging, testing, configuration, dev-ops</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/tp/DeveloperGuide.html#appendix-requirements" data-v-e6005420>Appendix: Requirements</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/tp/DeveloperGuide.html#appendix-instructions-for-manual-testing" data-v-e6005420>Appendix: Instructions for manual testing</a></div></li></ul></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/tp/AboutUs.html" data-v-e6005420>About Us</a></div></li> <!----></ul></div></div> <!----></nav> <div id="content-wrapper"><body><div style="display:flex;justify-content:center;align-items:center;"><span class="parisienne-regular" style="font-size:3em;font-weight:bold;">
WedLinker
</span></div></body> <p><a href="https://github.com/se-edu/addressbook-level3/actions"><img src="https://github.com/AY2425S1-CS2103T-F15-4/tp/workflows/Java%20CI/badge.svg" alt="CI Status" class="img-fluid"></a> <a href="https://app.codecov.io/gh/AY2425S1-CS2103T-F15-4/tp"><img src="https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg" alt="codecov" class="img-fluid"></a></p> <div style="display:flex;justify-content:center;align-items:center;"><img alt="WedLinker UI" src="/tp/images/Ui.png" width="500" onclick="openModal(this)"></div> <p><strong>WedLinker is a desktop application designed for professional wedding planners to seamlessly manage a variety of
</span></div></body> <p><a href="https://github.com/se-edu/addressbook-level3/actions"><img src="https://github.com/AY2425S1-CS2103T-F15-4/tp/workflows/Java%20CI/badge.svg" alt="CI Status" class="img-fluid"></a> <a href="https://codecov.io/gh/AY2425S1-CS2103T-F15-4/tp"><img src="https://codecov.io/gh/AY2425S1-CS2103T-F15-4/tp/graph/badge.svg?token=Q1U9KRM30F" alt="codecov" class="img-fluid"></a></p> <div style="display:flex;justify-content:center;align-items:center;"><img alt="WedLinker UI" src="/tp/images/Ui.png" width="700" onclick="openModal(this)"></div> <p><strong>WedLinker is a desktop application designed for professional wedding planners to seamlessly manage a variety of
vendors and clients across different locations for a wedding.</strong></p> <p>While the application has a GUI, most of the user interactions happens using a CLI (Command Line Interface).
This allows for efficient and streamlined management of wedding-related contacts through text-based commands.</p> <p>WedLinker provides a centralised address book that simplifies the complexities of coordinating multiple vendors,
venues and clients. It enhances communication and streamlines event planning tasks, making the wedding planning process
Expand Down
Loading

0 comments on commit 4f5e742

Please sign in to comment.