Skip to content

Commit

Permalink
Merge pull request #1 from CS2113-AY1819S1-T16-2/master
Browse files Browse the repository at this point in the history
240918
  • Loading branch information
Jeevz10 committed Sep 24, 2018
2 parents 0fd6d2f + fb469fc commit de8445f
Show file tree
Hide file tree
Showing 10 changed files with 376 additions and 118 deletions.
22 changes: 11 additions & 11 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,21 @@ https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_m
https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]

ifdef::env-github[]
image::docs/images/Ui.png[width="600"]
image::docs/images/Ui-mockup.png[width="600"]
endif::[]

ifndef::env-github[]
image::images/Ui.png[width="600"]
image::images/Ui-mockup.png[width="600"]
endif::[]

* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
* What's different from https://github.com/se-edu/addressbook-level3[level 3]:
** A more sophisticated GUI that includes a list panel and an in-built Browser.
** More test cases, including automated GUI testing.
** Support for _Build Automation_ using Gradle and for _Continuous Integration_ using Travis CI.
* This is a desktop Project Management application designed for project-based companies. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
* We provide an all-in-one platform that saves our consumers’ time and money. Our customers will feel at ease communicating with one another in their project team setting.
* Managers of project team are now able to oversee their employees and overall project easily and conveniently.
* Features:
** Project teams management.
** Employees management.
** Department management.
== Site Map

Expand All @@ -33,8 +34,7 @@ endif::[]

== Acknowledgements

* Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
_Marco Jakob_.
* Based of https://github.com/se-edu/addressbook-level4[AddressBook-Level4 project] created by the https://github.com/se-edu/[SE-EDU initiative]
* Libraries used: https://github.com/TestFX/TestFX[TextFX], https://bitbucket.org/controlsfx/controlsfx/[ControlsFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5]

== Licence : link:LICENSE[MIT]
Expand Down
55 changes: 28 additions & 27 deletions docs/AboutUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,54 @@
:imagesDir: images
:stylesDir: stylesheets

AddressBook - Level 4 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
{empty} +
%Project name% was developed by the https://github.com/orgs/CS2113-AY1819S1-T16-2/teams/developers[T16-2] team. +
+
We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].

== Project Team

=== John Doe
image::damithc.jpg[width="150", align="left"]
{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
=== Lee Ming Liang
image::icedcoffeeboy.jpg[width="150", align="left"]
{empty}[https://github.com/IcedCoffeeBoy[github]] [<<#, portfolio>>]

**Role:** Developer +
**Responsibilities:** TBD

Role: Project Advisor

'''

=== John Roe
image::lejolly.jpg[width="150", align="left"]
{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
=== Jie Liang Ang
image::jieliangang.jpg[width="150", align="left"]
{empty}[https://github.com/jieliangang[github]] [<<#, portfolio>>]

Role: Team Lead +
Responsibilities: UI
**Role:** Team Lead +
**Responsibilities:** TBD

'''

=== Johnny Doe
image::yijinl.jpg[width="150", align="left"]
{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
=== Jeevan Neralakere Somashekhar
image::jeevz10.jpg[width="150", align="left"]
{empty}[https://github.com/Jeevz10[github]] [<<#, portfolio>>]

Role: Developer +
Responsibilities: Data
**Role:** Developer +
**Responsibilities:** TBD

'''

=== Johnny Roe
image::m133225.jpg[width="150", align="left"]
{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
=== Perry Wang Zhi Ming
image::perrythewang.jpg[width="150", align="left"]
{empty}[https://github.com/perrythewang[github]] [<<#, portfolio>>]

Role: Developer +
Responsibilities: Dev Ops + Threading
**Role:** Developer +
**Responsibilities:** TBD

'''

=== Benson Meier
image::yl_coder.jpg[width="150", align="left"]
{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
=== Ruslan Farkhutdinov
image::fr3ddy4.jpg[width="150", align="left"]
{empty}[https://github.com/fr3ddy4[github]] [<<#, portfolio>>]

Role: Developer +
Responsibilities: UI
**Role:** Developer +
**Responsibilities:** TBD

'''
2 changes: 1 addition & 1 deletion docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= ProHelp - Developer Guide
= iHelp - Developer Guide
:site-section: DeveloperGuide
:toc:
:toc-title:
Expand Down

0 comments on commit de8445f

Please sign in to comment.