[CS2103T-F11-2] My Bookshelf

.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' # assuming your repo name is tp
+          version: '^5.2.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,34 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/AY2324S2-CS2103T-F11-2/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2324S2-CS2103T-F11-2/tp/actions/workflows/gradle.yml)
 
 ![Ui](docs/images/Ui.png)
+## About MyBookshelf
+* MyBookshelf is designed to improve and ease the management of public community libraries.
+* MyBookshelf helps to keep track of the person who has borrowed which books from the library.
+* MyBookShelf helps to keep track of the book transactions within the library.
+* MyBookShelf helps to keep track of the merit score of each user of the library.
+* This helps to prevent irresponsible behaviour that violates the library's borrowing guidelines, easing management duties.
+<br>
+
+## Project Details
+  * The project is CLI based to make it quick to use and  easy for users who prefer typing commands over mouse operations.
+  * The librarians can add, edit, find or delete users in order to keep track of the people who is using their library
+  * The librarians can keep track of borrowed books and the borrower's information as well as return transactions.
+  * The librarians can keep track donated books and the information of the donors.
+  * 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), without being overwhelmingly big.
+      * It comes with a reasonable level of user and developer documentation.
+
+* Example usages:
+  * Allows librarian to **add** new user
+  * Allows librarian to **list** all user
+  * Allows librarian to **edit** an existing user
+  * Allows librarian to **find** user whose names contain the given keywords
+  * Allows librarian to **delete** an existing user
+  * Allows librarian to create a **borrow** transaction
+  * Allows librarian to create a **return** transaction
+  * Allows librarian to create a **donate** transaction
+
+## Acknowledgement
+* For the detailed documentation of this project, see the **[MyBookshelf Product Website](https://ay2324s2-cs2103t-f11-2.github.io/tp/)**.
 
-* 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.

build.gradle

@@ -16,6 +16,10 @@ repositories {
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
 }
 
+run {
+    enableAssertions = true
+}
+
 checkstyle {
     toolVersion = '10.2'
 }
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'mybookshelf.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,61 @@
 ---
-layout: page
-title: About Us
+  layout: default.md
+  title: "About Us"
 ---
 
+# 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
+### Ho Jin Han
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jinhanfromnus.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/jinhanfromNUS)]
+[[portfolio](team/jinhanfromNUS.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Features and Documentation
 
-### Jane Doe
+### Khoo Jing Xiang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/meowwtama.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/meowwtama)]
+[[portfolio](team/meowwtama.md)]
 
-* Role: Team Lead
+* Role: Developer
 * Responsibilities: UI
 
-### Johnny Doe
+### Ashley Chang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ashleyclx.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/ashleyclx)] [[portfolio](team/ashleyclx.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Features and Documentation
 
-### Jean Doe
+### Tan Yi-Sheng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ty-stan0417.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/Ty-stan0417)]
+[[portfolio](team/Ty-stan0417.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Features and Documentation
 
-### James Doe
+### Shenoy Suraj Bantwal
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/darkarche3.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Darkarche3)]
+[[portfolio](team/Darkarche3.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Testing

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