[CS2103T-T15-3] EduTrack

.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

@@ -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,14 +1,63 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# EduTrack
+
+Here is a glimpse of what EduTrack looks like!
+
+[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-T15-3/tp/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.
+### **EduTrack** provides a **centralised system** to help SOC teaching assistants manage multiple classes.<br>
+You should expect **EduTrack** to be able to manage:
+* Student attendance
+* Additional notes for each student
+* Student class participation
+
+### Installation:
+* Ensure you have java 11 installed in your local computer
+  * If you are on **windows** or **linux**, download [here](https://www.oracle.com/sg/java/technologies/javase/jdk11-archive-downloads.html)
+  * If you on **macOS**, download [here](https://www.azul.com/downloads/?version=java-11-lts&os=macos&architecture=arm-64-bit&package=jdk-fx#zulu)
+* Download the [JAR file](https://github.com/AY2324S1-CS2103T-T15-3/tp/releases)
+* Run it!
+
+### Quick Start
+Follow the following commands to get started in setting up your EduTrack!
+
+**Create your class**
+```
+add /c cs2103t
+```
+`cs2103t` can be replaced by the name of your class
+
+**Add your student to the class**
+```
+add /s John /c 1
+```
+`1` - can be replaced by your class index which you can see using `list` command
+
+**Add your personalised class note**
+```
+edit /c 1 /m Reminder to take attendance!
+```
+`1` - can be replaced by your class index which you can see using `list` command
+
+**Mark your class attendance**
+```
+startlesson /c cs2103t
+mark /s 1 /c cs2103t
+```
+`cs2103t` - can be replaced by the name of your class
+
+`1` - can be replaced by the student index of your class which you can view using `view /c` command
+
+**Refer to our [user guide](https://ay2324s1-cs2103t-t15-3.github.io/tp/UserGuide.html) to see what else you can do!**
+
+### Contributors:
+  * Sean
+  * Sarah
+  * Kota
+  * Helin
+  * Donovan
+
+  Learn more [about us](https://github.com/AY2324S1-CS2103T-T15-3/tp/blob/master/docs/AboutUs.md)!
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.edutrack.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -66,7 +66,15 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'EduTrack.jar'
+}
+
+run {
+    enableAssertions = true
+}
+
+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,59 @@
 ---
-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](http://www.comp.nus.edu.sg).
+# About Us
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
 ## Project team
 
-### John Doe
+### Sean Phua Zeng Kiat
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/seanpzk.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/seanpzk)]
+[[portfolio](team/seanpzk.md)]
 
-* Role: Project Advisor
+* Role: Team Lead
+* Responsibilities: Project Coordination
 
-### Jane Doe
+### Donovan Chan Jia Jun
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/donovanjj.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/donovanjj)]
+[[portfolio](team/donovanjj.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Testing & Scheduling
 
-### Johnny Doe
+### Trinh Hoai Song Thu (Sarah)
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/songgthu.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/songgthu)] [[portfolio](team/songgthu.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Documentation
 
-### Jean Doe
+### Wang Helin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/revdrag.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/revdrag)]
+[[portfolio](team/revdrag.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Integration
 
-### James Doe
+### Kota Sudarshan Karanth
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/sudarshan2401.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/sudarshan2401)]
+[[portfolio](team/sudarshan2401.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Code Quality & Deliverables

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