[CS2103T-W15-4] CodeSphere

.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: '11'
+          distribution: 'temurin'
+      - name: Build & Deploy MarkBind site
+        uses: MarkBind/markbind-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          rootDirectory: './docs'
+          baseUrl: '/tp' # replace with your repo name
+          version: '^5.1.0'

.gitignore

@@ -2,6 +2,7 @@
 /.gradle/
 /build/
 src/main/resources/docs/
+/bin/
 
 # IDEA files
 /.idea/
@@ -21,3 +22,4 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/

README.md

@@ -1,14 +1,17 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
-
-![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.
+[![CI Status](https://github.com/AY2324S1-CS2103T-W15-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-W15-4/tp/actions)
+[![codecov](https://codecov.io/gh/AY2324S1-CS2103T-W15-4/tp/graph/badge.svg?token=6MDQ56W5QU)](https://codecov.io/gh/AY2324S1-CS2103T-W15-4/tp)
+
+![Ui](docs/images/course_display.png)
+
+## CodeSphere
+CodeSphere is a desktop contact management app, optimised for use via a Command Line Interface (CLI)
+while still having the benefits of a Graphical User Interface (GUI).
+It is an app targeted at enabling Teaching Assistants in NUS School of Computing to better manage their students.
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+
+### Project Links
+[Project Website](https://ay2324s1-cs2103t-w15-4.github.io/tp/)
+[User Guide](https://ay2324s1-cs2103t-w15-4.github.io/tp/UserGuide.html)
+[Developer Guide](https://ay2324s1-cs2103t-w15-4.github.io/tp/DeveloperGuide.html)
+[About Us](https://ay2324s1-cs2103t-w15-4.github.io/tp/AboutUs.html)

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.codesphere.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -66,7 +66,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'CodeSphere.jar'
+}
+
+run {
+    enableAssertions true
 }
 
 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,61 @@
 ---
-layout: page
-title: About Us
+  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`
+You can reach us at the email `devanshu[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Devanshu Bisht
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/devanshubisht.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/devanshubisht)]
+[[portfolio](team/devanshubisht.md)]
 
-* Role: Project Advisor
+* Role: Team Lead
+* Responsibilities: In charge of integration and overall logic of the application.
 
-### Jane Doe
+### Phinehas Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/phiphi-tan.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/phiphi-tan)]
+[[portfolio](team/phiphi-tan.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: User Interface (UI), Deliverables and Deadlines
+* Responsibilities: Implement user-interface related features for the application,
+ and ensure project deliverables are done on time and in the right format
 
-### Johnny Doe
+### Sun Zihan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/sunzihan23.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/sunzihan23)]
+[[portfolio](team/sunzihan23.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Code quality, documentation
+* Responsibilities: Ensures adherence to coding standards, responsible for the quality of project documents
 
-### Jean Doe
+### Tiong Jjyi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tiongjjyi.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tiongjjyi)]
+[[portfolio](team/tiongjjyi.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Scheduling and tracking
+* Responsibilities: In charge of defining, assigning, and tracking project tasks.
 
-### James Doe
+### Gallen Ong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/gongg21.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/gongg21)]
+[[portfolio](team/gongg21.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Developing and Testing
+* Responsibilities: In charge of command logic, integration of code, and overall testing of app.

docs/Configuration.md

@@ -1,6 +1,6 @@
 ---
-layout: page
-title: Configuration guide
+  layout: page
+  title: "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,10 @@
 ---
-layout: page
-title: DevOps guide
+  layout: page
+  title: "DevOps guide"
+  pageNav: 3
 ---
 
-* Table of Contents
-{:toc}
-
---------------------------------------------------------------------------------------------------------------------
+<!-- -------------------------------------------------------------------------------------------------------------------- -->
 
 ## Build automation
 
@@ -73,7 +71,7 @@ Any warnings or errors will be printed out to the console.
 
 Here are the steps to create a new release.
 
-1. Update the version number in [`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java).
+1. Update the version number in [`MainApp.java`](https://github.com/AY2324S1-CS2103T-W15-4/tp/blob/master/src/main/java/seedu/codesphere/MainApp.java).
 1. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`).
 1. Tag the repo with the version number. e.g. `v0.1`
 1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.