[CS2103T-T09-1] InternBuddy

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+name: MarkBind Action
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install Graphviz
+        run: sudo apt-get install graphviz
+      - name: Install Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'zulu'
+      - name: Build & Deploy MarkBind site
+        uses: MarkBind/markbind-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          rootDirectory: './docs'
+          baseUrl: '/tp' # assuming your repo name is tp
+          version: '^5.5.2'

.gitignore

@@ -21,3 +21,4 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/

README.md

@@ -1,11 +1,20 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# [InternBuddy](https://ay2425s1-cs2103t-t09-1.github.io/tp/) · [![CI Status](https://github.com/AY2425S1-CS2103T-T09-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S1-CS2103T-T09-1/tp/actions) [![codecov](https://codecov.io/gh/AY2425S1-CS2103T-T09-1/tp/graph/badge.svg?token=IPPD93O9IR)](https://codecov.io/gh/AY2425S1-CS2103T-T09-1/tp)
 
 ![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
+InternBuddy is a desktop application used for managing contact details.
+
+## Target user
+> This product is for university students studying a STEM major, specifically those seeking summer internships. They are typically busy with assignments while applying for summer internships. As a result, they may lose track of key information about companies they have applied for in a constantly increasing list of applications made.
+
+## Value proposition
+> InternBuddy aims to simplify and efficiently manage internship application details, optimised for fast typers who prefer a CLI interface. It enables users to track key information such as HR contacts, interview dates, and application statues, all while maintaining portability across multiple operating systems without requiring a remote server.
+
+## Project notes
+See [here](https://docs.google.com/document/d/18DnZEyYiCFxt_Ajr6h_bGZwW8NYn5JeZz8Yt1XOGvDw/edit?usp=sharing)
+
+## Acknowledgements
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
 * 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**.

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.internbuddy.Main'
 
 sourceCompatibility = JavaVersion.VERSION_17
 targetCompatibility = JavaVersion.VERSION_17
@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '10.2'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'internbuddy.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/.gitignore

@@ -0,0 +1,23 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+_markbind/logs/
+
+# Dependency directories
+node_modules/
+
+# Production build files (change if you output the build to a different directory)
+_site/
+
+# Env
+.env
+.env.local
+
+# IDE configs
+.vscode/
+.idea/*
+*.iml

docs/AboutUs.md

@@ -1,59 +1,62 @@
 ---
-layout: page
-title: About Us
+  layout: default.md
+  title: "About Us"
 ---
 
-We are a team based in the [School of Computing, National University of Singapore](https://www.comp.nus.edu.sg).
+# 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
 
-### John Doe
+### Jaymeson Koh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/blanklogic.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/blanklogic)]
+[[portfolio](team/jaymeson.md)]
 
-* Role: Project Advisor
+* Role: Team Lead
+* Responsibilities: Integration, Testing, Code Quality
 
-### Jane Doe
+### Varun Shukla
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/shux347.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/Shux347)]
+[[portfolio](team/varun.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Project Manager
+* Responsibilities: Scheduling and tracking, Deliverables and deadlines
 
-### Johnny Doe
+### Erwin Soh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/meerkatboy.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/meerkatboy)]
+[[portfolio](team/erwin.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Testing Lead
+* Responsibilities: Testing, Code Quality, UI
 
-### Jean Doe
+### Simon Tong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/uniqly.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/uniqly)]
+[[portfolio](team/simon.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Documentation Lead
+* Responsibilities: Documentation, Testing, Code Quality
 
-### James Doe
+### Ang Qi Jun
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/realqijun.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/realqijun)]
+[[portfolio](team/qijun.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: UI Lead
+* Responsibilities: UI, Documentation

docs/Configuration.md

@@ -1,6 +1,8 @@
 ---
-layout: page
-title: Configuration guide
+  layout: default.md
+  title: "Configuration guide"
 ---
 
+# Configuration guide
+
 Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).

docs/DevOps.md

@@ -1,12 +1,15 @@
 ---
-layout: page
-title: DevOps guide
+  layout: default.md
+  title: "DevOps guide"
+  pageNav: 3
 ---
 
-* Table of Contents
-{:toc}
+# DevOps guide
 
---------------------------------------------------------------------------------------------------------------------
+<!-- * Table of Contents -->
+<page-nav-print />
+
+<!-- -------------------------------------------------------------------------------------------------------------------- -->
 
 ## Build automation