[CS2113T-F12-4] CCAManager

README.md

@@ -1,65 +1,14 @@
-# Duke project template
+# CCA Manager
 
-This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
+This is a project for a greenfield Java project. CCA Manager is a CLI application, and it is designed to help CCA's manage their administrative issues.
 
-## Setting up in Intellij
+Prerequisites: `JDK 11`, update Intellij to the most recent version.
 
-Prerequisites: JDK 11 (use the exact version), update Intellij to the most recent version.
+## Useful Links
 
-1. **Ensure Intellij JDK 11 is defined as an SDK**, as described [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk) -- this step is not needed if you have used JDK 11 in a previous Intellij project.
-   * In the same dialog, you _may_ have to set the Project language level field to the SDK default option.
-1. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
-1. **Verify the set up**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
-   ```
-   > Task :compileJava
-   > Task :processResources NO-SOURCE
-   > Task :classes
-
-   > Task :Duke.main()
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-
-   What is your name?
-   ```
-   Type some word and press enter to let the execution proceed to the end.
+[User Guide](https://ay2122s1-cs2113t-f12-4.github.io/tp/UserGuide.html) - Get an overview of the supported commands and syntaxes here
 
-## Build automation using Gradle
+[Developer Guide](https://ay2122s1-cs2113t-f12-4.github.io/tp/DeveloperGuide.html) - View the developers guide here
 
-* This project uses Gradle for build automation and dependency management. It includes a basic build script as well (i.e. the `build.gradle` file).
-* If you are new to Gradle, refer to the [Gradle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/gradle.html).
+[About Us](https://ay2122s1-cs2113t-f12-4.github.io/tp/AboutUs.html) - Learn more about the developer here
 
-## Testing
-
-### I/O redirection tests
-
-* To run _I/O redirection_ tests (aka _Text UI tests_), navigate to the `text-ui-test` and run the `runtest(.bat/.sh)` script.
-
-### JUnit tests
-
-* A skeleton JUnit test (`src/test/java/seedu/duke/DukeTest.java`) is provided with this project template. 
-* If you are new to JUnit, refer to the [JUnit Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/junit.html).
-
-## Checkstyle
-
-* A sample CheckStyle rule configuration is provided in this project.
-* If you are new to Checkstyle, refer to the [Checkstyle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/checkstyle.html).
-
-## CI using GitHub Actions
-
-The project uses [GitHub actions](https://github.com/features/actions) for CI. When you push a commit to this repo or PR against it, GitHub actions will run automatically to build and verify the code as updated by the commit/PR.
-
-## Documentation
-
-`/docs` folder contains a skeleton version of the project documentation.
-
-Steps for publishing documentation to the public: 
-1. If you are using this project template for an individual project, go your fork on GitHub.<br>
-   If you are using this project template for a team project, go to the team fork on GitHub.
-1. Click on the `settings` tab.
-1. Scroll down to the `GitHub Pages` section.
-1. Set the `source` as `master branch /docs folder`.
-1. Optionally, use the `choose a theme` button to choose a theme for your documentation.

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-slate

build.gradle

@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,9 @@
 # About us
 
-Display | Name | Github Profile | Portfolio 
+Display | Member Name | Github Profile | Project Portfolio Page (PPP)
 --------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Xing Yuan | [xingyuan123](https://github.com/xingyuan123) | [Portfolio](https://ay2122s1-cs2113t-f12-4.github.io/tp/team/xingyuan123.html)
+![](https://via.placeholder.com/100.png?text=Photo) | Teck Hwee | [Teckwhye](https://github.com/Teckwhye) | [Portfolio](https://ay2122s1-cs2113t-f12-4.github.io/tp/team/teckwhye.html)
+![](https://via.placeholder.com/100.png?text=Photo) | Glenn Tan | [poppolette](https://github.com/poppolette) | [Portfolio](https://ay2122s1-cs2113t-f12-4.github.io/tp/team/poppolette.html)
+![](https://via.placeholder.com/100.png?text=Photo) | Izdiyad Farhan | [izdiyadfrhn](https://github.com/izdiyadfrhn) | [Portfolio](https://ay2122s1-cs2113t-f12-4.github.io/tp/team/izdiyadfrhn.html)
+![](https://via.placeholder.com/100.png?text=Photo) | Ian Wang | [ianwangeeen](https://github.com/ianwangeeen) | [Portfolio](https://ay2122s1-cs2113t-f12-4.github.io/tp/team/ianwangeeen.html)