[CS2103T-W10-1] TAfinder

.gitignore

@@ -21,3 +21,180 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+
+/bin/
+
+##################################
+### Generated by ignore v0.1.0 ###
+##################################
+
+#############
+### macOS ###
+#############
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+############
+### Node ###
+############
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+###############
+### The end ###
+###############

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "editor.formatOnSave": false,
+    "editor.detectIndentation": false
+}

README.md

@@ -1,14 +1,30 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# TAfinder
+
+[![codecov](https://codecov.io/gh/AY2324S1-CS2103T-W10-1/tp/graph/badge.svg?token=4DBT7T1IUV)](https://codecov.io/gh/AY2324S1-CS2103T-W10-1/tp)
+
+This is a CS2103T project by [AY2324S1-CS2103T-W10-1](https://ay2324s1-cs2103t-w10-1.github.io/tp/AboutUs.html). It is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org/).
+
+TAfinder is a desktop app for NUS professors to find and track Teaching Assistant (TA) information. It is optimised for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you are an NUS professor that can type fast, and who is in need of an app to find and manage TA information, TAfinder is the app for you!
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
-  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
-  * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+## Features
+
+- **Basic Applicant management**
+    - Listing all applicants: `list`
+    - Hiding/unhiding an applicant from the list: `hide`/`unhide`
+    - Editing an applicant's information: `edit`
+    - Adding an applicant: `add`
+    - Viewing an applicant's details: `view`
+- **Applicant evaluation & comparison**
+  - Sorting applicants by grades: `sort`
+  - Comparing 2 applicants: `compare`
+  - Bookmarking/Unbookmarking an applicant: `bookmark`/`unbookmark`
+  - Adding comments for an applicant: `comment`
+- **Data management and export**
+  - Import applicants from a spreadsheet: `import`
+  - Attaching file to an applicant's profile: `attach`
+
+## Issues and Bugs
+
+Spot a bug? Let us know by launching a Bug Report at the [Issues tab](https://github.com/AY2324S1-CS2103T-W10-1/tp/issues)!

build.gradle

@@ -65,8 +65,12 @@ dependencies {
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
+run {
+    enableAssertions = true
+}
+
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'tafinder.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -1,59 +1,57 @@
 ---
-layout: page
 title: About Us
 ---
 
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+## Project Team
 
-## Project team
+### Ravern Koh
 
-### John Doe
+<img src="images/ravern.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](https://github.com/ravern)]
+[[portfolio](team/ravern.md)]
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Project Advisor
+* Role: Team Lead
+* Responsibilities: UI
 
-### Jane Doe
+### Amos Ting
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/amosting.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/amosting)]
+[[portfolio](team/amosting.md)]
 
-* Role: Team Lead
+* Role: Testing
 * Responsibilities: UI
 
-### Johnny Doe
+### Heng Yi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lheng1.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/lheng1)]
+[[portfolio](team/lheng1.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Code Quality
+* Responsibilities: Model
 
-### Jean Doe
+### Nabonita Sen
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/nabonitasen.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/nabonitasen)]
+[[portfolio](team/nabonitasen.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Deliverables and Deadlines
+* Responsibilities: Model
 
-### James Doe
+### Amy Ling
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ylyma.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ylyma)]
+[[portfolio](team/ylyma.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Documentation
+* Responsibilities: Storage

docs/Configuration.md

@@ -1,5 +1,4 @@
 ---
-layout: page
 title: Configuration guide
 ---
 

docs/DevOps.md

@@ -1,13 +1,7 @@
 ---
-layout: page
 title: DevOps guide
 ---
 
-* Table of Contents
-{:toc}
-
---------------------------------------------------------------------------------------------------------------------
-
 ## Build automation
 
 This project uses Gradle for **build automation and dependency management**. **You are recommended to read [this Gradle Tutorial from the se-edu/guides](https://se-education.org/guides/tutorials/gradle.html)**.