Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/nus-cs3281/2025
Browse files Browse the repository at this point in the history
  • Loading branch information
yucongkoo committed Jan 27, 2025
2 parents e447aa4 + 2b7e5b9 commit c5977de
Show file tree
Hide file tree
Showing 40 changed files with 176 additions and 49 deletions.
3 changes: 1 addition & 2 deletions cs3282-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ pageNav: 2
{name: 'CATcher', students: [
['ARIF KHALID', 'Arif-Khalid', 'A1', 'B1', 'C1'],
['Li Zhaoqi', 'Eclipse-Dominator', 'A2', 'B2', 'C2'],
['NGUYEN KHOI NGUYEN', 'nknguyenhc', 'A2', 'B2', 'C2'],
['Sun Xinyu', 'Echomo-Xinyu', 'A1', 'B1', 'C1']
['NGUYEN KHOI NGUYEN', 'nknguyenhc', 'A2', 'B2', 'C2']
]},
{name: 'MarkBind', students: [
['Lee Hyung Woon', 'lhw-1', 'A2', 'B2', 'C2']
Expand Down
4 changes: 2 additions & 2 deletions students/Airiinnn/info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<!-- Give link to your github home page -->
<span id="github">https://www.github.com/johnDoe</span>
<span id="github">https://www.github.com/Airiinnn</span>

<!-- [CS3281: Give your NUS-OSS project][CS3282: give your internal and external projects related to the module] -->
<span id="projects">[Project1](), [Project2]()</span>
<span id="projects">[RepoSense](https://github.com/reposense)</span>
Binary file modified students/Airiinnn/photo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions students/BunnyHoppp/info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<!-- Give link to your github home page -->
<span id="github">https://www.github.com/johnDoe</span>
<span id="github">https://www.github.com/BunnyHoppp</span>

<!-- [CS3281: Give your NUS-OSS project][CS3282: give your internal and external projects related to the module] -->
<span id="projects">[Project1](), [Project2]()</span>
<span id="projects">[TEAMMATES](https://github.com/TEAMMATES/teammates)</span>
Binary file modified students/BunnyHoppp/photo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions students/DhiraPT/info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<!-- Give link to your github home page -->
<span id="github">https://www.github.com/johnDoe</span>
<span id="github">https://www.github.com/DhiraPT</span>

<!-- [CS3281: Give your NUS-OSS project][CS3282: give your internal and external projects related to the module] -->
<span id="projects">[Project1](), [Project2]()</span>
<span id="projects">[TEAMMATES](https://github.com/TEAMMATES/teammates), [Project2]()</span>
4 changes: 2 additions & 2 deletions students/HollaG/info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<!-- Give link to your github home page -->
<span id="github">https://www.github.com/johnDoe</span>
<span id="github">https://www.github.com/hollag</span>

<!-- [CS3281: Give your NUS-OSS project][CS3282: give your internal and external projects related to the module] -->
<span id="projects">[Project1](), [Project2]()</span>
<span id="projects">[CATcher](https://github.com/CATcher-org/CATcher), [WATcher](https://github.com/CATcher-org/WATcher)</span>
Binary file modified students/HollaG/photo.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: 2 additions & 0 deletions students/HollaG/progress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
| Week | Achievements |
| ---- | ------------ |
4 changes: 2 additions & 2 deletions students/IanCheah/info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<!-- Give link to your github home page -->
<span id="github">https://www.github.com/johnDoe</span>
<span id="github">https://www.github.com/IanCheah</span>

<!-- [CS3281: Give your NUS-OSS project][CS3282: give your internal and external projects related to the module] -->
<span id="projects">[Project1](), [Project2]()</span>
<span id="projects">[MarkBind](https://github.com/MarkBind/markbind), [Project2]()</span>
Binary file modified students/IanCheah/photo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions students/Incogdino/info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<!-- Give link to your github home page -->
<span id="github">https://www.github.com/johnDoe</span>
<span id="github">https://github.com/Incogdino</span>

<!-- [CS3281: Give your NUS-OSS project][CS3282: give your internal and external projects related to the module] -->
<span id="projects">[Project1](), [Project2]()</span>
<span id="projects">[Markbind](https://github.com/MarkBind/markbind), [Project2]()</span>
Binary file modified students/Incogdino/photo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions students/InfinityTwo/info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<!-- Give link to your github home page -->
<span id="github">https://www.github.com/johnDoe</span>
<span id="github">https://www.github.com/InfinityTwo</span>

<!-- [CS3281: Give your NUS-OSS project][CS3282: give your internal and external projects related to the module] -->
<span id="projects">[Project1](), [Project2]()</span>
<span id="projects">[TEAMMATES](https://github.com/TEAMMATES)</span>
Binary file modified students/InfinityTwo/photo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions students/Izn432/info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<!-- Give link to your github home page -->
<span id="github">https://www.github.com/johnDoe</span>
<span id="github">https://www.github.com/IzN432</span>

<!-- [CS3281: Give your NUS-OSS project][CS3282: give your internal and external projects related to the module] -->
<span id="projects">[Project1](), [Project2]()</span>
<span id="projects">[CATcher](https://github.com/CATcher-org/CATcher), [WATcher](https://github.com/CATcher-org/WATcher)</span>
Binary file modified students/Izn432/photo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions students/JoanneHing/info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<!-- Give link to your github home page -->
<span id="github">https://www.github.com/johnDoe</span>
<!-- Give link to your gitHub home page -->
<span id="github">https://github.com/JoanneHing</span>

<!-- [CS3281: Give your NUS-OSS project][CS3282: give your internal and external projects related to the module] -->
<span id="projects">[Project1](), [Project2]()</span>
<span id="projects">[Reposense](https://github.com/reposense)</span>
5 changes: 2 additions & 3 deletions students/JoanneHing/knowledge.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
### Tool/Technology 1

List the aspects you learned, and the resources you used to learn them, and a brief summary of each resource.
## gitHub Actions
1. I learned how to update gitHub action runners to different version for macOS, ubuntu and window. Resource referred from [stackoverflow](https://stackoverflow.com/questions/77781713/using-github-strategy-matrix-to-select-a-runner). I found that how the gitHub runner is updated using the gitHub strategy matrix.

### Tool/Technology 2

Expand Down
Binary file modified students/JoanneHing/photo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions students/JoanneHing/progress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
| Week | Achievements |
|------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| 1 | Solved issue: [Upgrade GitHub Actions macOS runners to 13 and 14 (and possibly 15) #2259](https://github.com/reposense/RepoSense/issues/2259) |
| 1 | Solved issue: [Add ubuntu-24.04 to CI runners and bump publish-RepoSense runner #2252](https://github.com/reposense/RepoSense/issues/2252) |
4 changes: 2 additions & 2 deletions students/NorbertLoh/info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<!-- Give link to your github home page -->
<span id="github">https://www.github.com/johnDoe</span>
<span id="github">https://github.com/NorbertLoh</span>

<!-- [CS3281: Give your NUS-OSS project][CS3282: give your internal and external projects related to the module] -->
<span id="projects">[Project1](), [Project2]()</span>
<span id="projects">[CATcher](https://github.com/CATcher-org/CATcher), [WATcher](https://github.com/CATcher-org/WATcher)</span>
Binary file modified students/NorbertLoh/photo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 42 additions & 3 deletions students/gerteck/knowledge.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,46 @@
### Tool/Technology 1
### Tool/Technology

List the aspects you learned, and the resources you used to learn them, and a brief summary of each resource.

### Tool/Technology 2
# Markbind's Search Utility

## How Native MarkBind Search works
**Collection of Title and headings in generation:**
* We trace the website generation in `Site/index.ts`.
* When building source files, during the page generation process, `Page.collectHeadingsAndKeywords` records headings and keywords inside rendered page into this.headings and this.keywords respectively.
* When writing site data, the title, headings, keywords are collected into pages object.

**Page Generation and Vue Initialization**
* In `core-web/src/index.js`, the `setupWithSearch()` updates the SearchData by collecting the pages from the site data.
* `setupWithSearch()` is added as a script in the file template `page.njk` used to render the HTML structure of Markbind pages.
* This file template is used during the page generation process.
* Note also that `VueCommonAppFactory.js` provides a factory function (appFactory) to set up the common data and methods for Vue application shared between server-side and client-side, and provides the common data properties and methods.
* In particular, `searchData[]` and `searchCallback()`, which are relevant in the following portion.
* When using `<searchbar/>`, this is where to use MarkBind's search functionality, we set the appropriate values: ` <searchbar :data="searchData" :on-hit="searchCallback"></searchbar>`

**Vue Components: Searchbar/SearchbarPageItem.vue**
**Searchbar.vue**
* The searchbar uses the `searchData[]` in `data`, filters and ranks the data based on keyword matches and populates the dropdown with `searchbarPageItems`.
* It calls the `on-hit` function when a search result is selected, passing the selected item.
**SearchbarPageItem.vue**
* Decides how to present the item based on whether it is a heading or a page title.


## How Proposed Markbind PageFind Plugin Works

About [PageFind](https://pagefind.app/): A fully static search library that aims to perform well on large sites, while using as little of users bandwidth
as possible, and without hosting any infrastructure.

**Documentation:**
* [PageFind NodeJS Indexing API](https://pagefind.app/docs/node-api/)
* [The types returned by Pagefind’s JavaScript search API](https://github.com/CloudCannon/pagefind/blob/production-docs/pagefind_web_js/types/index.d.ts)

### **Integration of Pagefind into MarkBind**
It runs after the website framework, and only requires the folder containing the built static files of the website. A short explanation of how it works would be:

* PageFind indexes the static files
* If pagefind is included as a plugin, we indexSites with PageFind, which writes the index files _site/pagefind
* Plugin exposes a pagefind JS API for searching
* Alternatively, use pagefind default UI for searching. This is done by processes containers with "id="pagefind-search-input"", and initialing a default PageFindUI instance on it, not unlike how algolia search works.
* This JS API is used by a custom Vue component searchbar.

...
10 changes: 10 additions & 0 deletions students/gerteck/progress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
### Summary

Over the semester, I will be working on MarkBind.

The work will build on previous work done, recorded [here](https://docs.google.com/document/d/1PjA6jfa7G_ZNjc8zSWi1hVSMmhbrGUY95k0ytyDCo-Y/edit?usp=sharing)


| Week | Achievements |
| ---- | ------------ |
| 1 | Authored PR: [Add Pagefind Plugin #2568](https://github.com/MarkBind/markbind/pull/2568) |
47 changes: 47 additions & 0 deletions students/jasonqiu212/progress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## Summary

## Pre-CS3282 Work

| Date | Achievements |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 27 Apr 2023 | Reviewed PR: [[#12327] Consolidate duplicate modified timestamp modals #12403](https://github.com/TEAMMATES/teammates/pull/12403) |
| 2 May 2023 | Reviewed PR: [[#12281] Fix deleted feedback sessions table overflow #12408](https://github.com/TEAMMATES/teammates/pull/12408) |
| 9 May 2023 | Reviewed PR: [[#12267] Instructor getting started page: Fix scroll to top #12419](https://github.com/TEAMMATES/teammates/pull/12419) |
| 20 May 2023 | Proposed solution: [[#12010] Notifications box overlaps with the page menu in the instructor help page #12428](https://github.com/TEAMMATES/teammates/pull/12428) |
| 21 May 2023 | Reviewed PR: [[#10976] Document frontend standardizations #12436](https://github.com/TEAMMATES/teammates/pull/12436) |
| 25 May 2023 | Reviewed PR: [[#12329] Refactoring of Extension Confirmation table #12425](https://github.com/TEAMMATES/teammates/pull/12425) |
| 13 Jul 2023 | Reviewed PR: [[#11947] Format error toasts #12509](https://github.com/TEAMMATES/teammates/pull/12509) |
| 23 Jul 2023 | Reviewed PR: [[#12444] Updated development.md #12525](https://github.com/TEAMMATES/teammates/pull/12525) |
| 23 Jul 2023 | Reviewed PR: [[#12329] Refactoring of sortable tables - Sessions table](https://github.com/TEAMMATES/teammates/pull/12501) |
| 31 Jul 2023 | Reviewed PR: [[#10508] Instructor courses page: some items don't show spinners #12521](https://github.com/TEAMMATES/teammates/pull/12521) |
| 31 Jul 2023 | Raised issue: [Instructor sessions page: Empty deleted sessions table is not displayed #12538](https://github.com/TEAMMATES/teammates/issues/12538) |
| 2 Aug 2023 | Reviewed PR: [[#12530] Allow header dropdown to be opened with enter key #12542](https://github.com/TEAMMATES/teammates/pull/12542) |
| 2 Aug 2023 | Reviewed PR: [[#12533] Instructor Home Page: tabbing on Course Dropdown #12541](https://github.com/TEAMMATES/teammates/pull/12541) |
| 5 Aug 2023 | Merged PR: [[#12544] Rubric Question Statistics: Handle empty weights #12545](https://github.com/TEAMMATES/teammates/pull/12545) |
| 5 Aug 2023 | Raised issue: [Empty weights for MCQ #12547](https://github.com/TEAMMATES/teammates/issues/12547) |
| 8 Aug 2023 | Reviewed PR: [[#12532] Instructor Home Page: Remind dropdown expands into the table #12543](https://github.com/TEAMMATES/teammates/pull/12543) |
| 19 Aug 2023 | Reviewed PR: [[#12313] Instructor sending submission reminders: missing space between checkbox and label #12553](https://github.com/TEAMMATES/teammates/pull/12553) |
| 2 Sep 2023 | Reviewed PR: [[#12279] Instructor home page: Improve display of card header on mobile #12567](https://github.com/TEAMMATES/teammates/pull/12567) |
| 6 Sep 2023 | Reviewed PR: [[#12551] Sessions page fix #12561](https://github.com/TEAMMATES/teammates/pull/12561) |
| 8 Sep 2023 | Reviewed PR: [[#12314] Popover appears in front of modal blocking buttons #12573](https://github.com/TEAMMATES/teammates/pull/12573) |
| 8 Sep 2023 | Reviewed PR: [[#12499] Flickering questions when loading session results #12570](https://github.com/TEAMMATES/teammates/pull/12570#pullrequestreview-1618557682) |
| 15 Sep 2023 | Reviewed PR: [[#12276] Instructor edit session page: Fix custom visibility table overflow #12574](https://github.com/TEAMMATES/teammates/pull/12574) |
| 21 Sep 2023 | Reviewed PR: [[#12329] Refactoring of sortable tables - Student list #12539](https://github.com/TEAMMATES/teammates/pull/12539) |
| 21 Sep 2023 | Reviewed PR: [[#12329] Refactoring of sortable tables - Extension Confirm Modal #12556](https://github.com/TEAMMATES/teammates/pull/12556) |
| 21 Sep 2023 | Reviewed PR: [[#12588] Add unit tests to copy course modal component #12590](https://github.com/TEAMMATES/teammates/pull/12590) |
| 21 Sep 2023 | Reviewed PR: [[#12588] Add unit tests to comment-visibility-setting-pipe #12589](https://github.com/TEAMMATES/teammates/pull/12589) |
| 23 Sep 2023 | Reviewed PR: [[#12283] Instructor view session results (course-wide): Add separate button to download results by question #12591](https://github.com/TEAMMATES/teammates/pull/12591) |
| 24 Sep 2023 | Reviewed PR: [[#12571] Instructors Edit Feedback Session: Instructor is able to edit submission opening time to an earlier timing #12580](https://github.com/TEAMMATES/teammates/pull/12580) |
| 25 Sep 2023 | Reviewed PR: [[#12588] Add unit tests to datepicker component #12592](https://github.com/TEAMMATES/teammates/pull/12592) |
| 26 Sep 2023 | Reviewed PR: [[#12588] Add unit tests to DatePickerFormatter #12593](https://github.com/TEAMMATES/teammates/pull/12593) |
| 29 Sep 2023 | Merged PR: [[#12466] Docs: Clarify masquerade mode #12595](https://github.com/TEAMMATES/teammates/pull/12595) |
| 30 Sep 2023 | Reviewed PR: [[#12557] Instructor edit feedback session page: NumberFormatException when inputting decimal numbers into distribute points questions #12558](https://github.com/TEAMMATES/teammates/pull/12558) |
| 1 Oct 2023 | Reviewed PR: [[#12588] Added unit tests to CourseEditForm component. #12597](https://github.com/TEAMMATES/teammates/pull/12597) |
| 28 Oct 2023 | Reviewed PR: [[#12588] Add unit tests for FeedbackPathPanelComponent #12613](https://github.com/TEAMMATES/teammates/pull/12613) |
| 21 Dec 2023 | Reviewed PR: [[#12668] Instructor's Student Records Page: Feedback session panel chevron barely visible #12673](https://github.com/TEAMMATES/teammates/pull/12673) |

## CS3282 Work

| Week | Achievements |
| ---- | ------------ |
| XXXX | XXX |
4 changes: 2 additions & 2 deletions students/joeng03/info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<!-- Give link to your github home page -->
<span id="github">https://www.github.com/johnDoe</span>
<span id="github">https://www.github.com/joeng03</span>

<!-- [CS3281: Give your NUS-OSS project][CS3282: give your internal and external projects related to the module] -->
<span id="projects">[Project1](), [Project2]()</span>
<span id="projects">[RepoSense](https://github.com/reposense)</span>
Binary file added students/joeng03/photo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions students/lyuanww/info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<!-- Give link to your github home page -->
<span id="github">https://www.github.com/johnDoe</span>
<span id="github">https://github.com/lyuanww</span>

<!-- [CS3281: Give your NUS-OSS project][CS3282: give your internal and external projects related to the module] -->
<span id="projects">[Project1](), [Project2]()</span>
<span id="projects">[RepoSense](https://github.com/reposense/RepoSense), [Project2]()</span>
Binary file modified students/lyuanww/photo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit c5977de

Please sign in to comment.