Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update #65

Open
wants to merge 52 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
df20982
Test travis build
rafflesandrison Feb 14, 2019
ab26cee
Delete delete_me.txt
rafflesandrison Feb 14, 2019
8648575
Update README - travis build badge link
rafflesandrison Feb 14, 2019
9afcd50
Test travis auto-documentation
rafflesandrison Feb 14, 2019
2a19bcc
Remove test line
rafflesandrison Feb 14, 2019
302d1e9
Add UI mockup of intended product
rafflesandrison Feb 18, 2019
71cc7b0
Restructure README
rafflesandrison Feb 18, 2019
a1306bd
Modify README
rafflesandrison Feb 18, 2019
42441f5
Merge pull request #1 from rafflesandrison/master
rafflesandrison Feb 18, 2019
fac81c4
test push
PhilipPhil Feb 18, 2019
75603e1
changed my info
PhilipPhil Feb 18, 2019
131cb87
Updated AboutUs
PhilipPhil Feb 18, 2019
51fc0c9
corrected Stanley's githublink
PhilipPhil Feb 18, 2019
e7eb969
fixed text
PhilipPhil Feb 18, 2019
8ab7879
fixed email
PhilipPhil Feb 18, 2019
78b6ae5
Merge pull request #6 from PhilipPhil/master
rafflesandrison Feb 19, 2019
d3f53ad
Merge pull request #1 from cs2103-ay1819s2-w15-1/master
rafflesandrison Feb 19, 2019
bb894d0
Fix travis build fail
rafflesandrison Feb 18, 2019
bb126c3
Merge pull request #7 from rafflesandrison/master
rafflesandrison Feb 19, 2019
f259780
Update DeveloperGuide
EugeneYiren Feb 19, 2019
dcd1f59
update userguide
stanleymok Feb 19, 2019
cb19289
Merge pull request #8 from ReinSheer/master
rafflesandrison Feb 19, 2019
928ff09
Merge pull request #2 from cs2103-ay1819s2-w15-1/master
rafflesandrison Feb 19, 2019
acb8d59
Fix DeveloperGuide Travis Build fail
rafflesandrison Feb 19, 2019
91b4a2d
update style
stanleymok Feb 19, 2019
0b1e129
update trailing white space
stanleymok Feb 19, 2019
6136b5a
Merge pull request #10 from rafflesandrison/master
rafflesandrison Feb 19, 2019
370d80c
Merge pull request #9 from stanleymok/master
rafflesandrison Feb 19, 2019
d436b0a
Merge pull request #3 from cs2103-ay1819s2-w15-1/master
rafflesandrison Feb 19, 2019
8a31633
Merge pull request #11 from rafflesandrison/master
rafflesandrison Feb 19, 2019
8c29dc1
Merge pull request #1 from cs2103-ay1819s2-w15-1/master
PhilipPhil Feb 20, 2019
9ed1204
Update About Us doc with photos
rafflesandrison Feb 22, 2019
0cf2bdf
Remove extra line
rafflesandrison Feb 22, 2019
76b5460
Fix image not display
rafflesandrison Feb 22, 2019
1d6f7e0
Fix image not displaying on github
rafflesandrison Feb 22, 2019
a97d00d
Fix image not displaying
rafflesandrison Feb 22, 2019
cb30916
Merge pull request #36 from rafflesandrison/master
rafflesandrison Feb 25, 2019
71153eb
Create Apparel class and it's corresponding classes
rafflesandrison Feb 25, 2019
b3c5358
Add javadoc comments.
rafflesandrison Feb 25, 2019
d5ab103
Fix checkstyle
rafflesandrison Feb 25, 2019
94ed184
Merge pull request #40 from rafflesandrison/fundamental-classes
rafflesandrison Feb 25, 2019
cfea6c8
Merge pull request #2 from cs2103-ay1819s2-w15-1/master
PhilipPhil Mar 3, 2019
6cb2848
Add validation methods.
rafflesandrison Mar 4, 2019
9af29d8
Fix travis build error
rafflesandrison Mar 4, 2019
7eb7d1f
Fix travis build error attemp #2
rafflesandrison Mar 4, 2019
9ee2ac4
Merge pull request #41 from rafflesandrison/fundamental-classes
rafflesandrison Mar 4, 2019
94a2df8
Merge pull request #3 from cs2103-ay1819s2-w15-1/master
PhilipPhil Mar 4, 2019
e499529
Recommendation Command implimented but not working.
PhilipPhil Mar 4, 2019
91105a0
Revert "update"
PhilipPhil Mar 4, 2019
a1f6b0c
Merge pull request #4 from PhilipPhil/revert-3-master
PhilipPhil Mar 4, 2019
5751935
Revert "update"
PhilipPhil Mar 4, 2019
f886b19
Merge pull request #5 from PhilipPhil/revert-3-master
PhilipPhil Mar 4, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Address Book (Level 4)
= Fashion Match
ifdef::env-github,env-browser[:relfileprefix: docs/]

https://travis-ci.org/se-edu/addressbook-level4[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
https://travis-ci.org/cs2103-ay1819s2-w15-1/main[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
https://coveralls.io/github/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
Expand All @@ -14,26 +14,30 @@ ifndef::env-github[]
image::images/Ui.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 Fashion Match application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).

== Site Map

* <<UserGuide#, User Guide>>
* <<DeveloperGuide#, Developer Guide>>
* <<LearningOutcomes#, Learning Outcomes>>
* <<AboutUs#, About Us>>
* <<ContactUs#, Contact Us>>

== Acknowledgements
== Target Users
* People who wants to have an easy solution for matching of everyday apparels.
* People who does not want to spend too much time thinking about whether his choice of outfit actually matches correctly.
* People who want to know the alternative matching combination to his current choice of base apparel.

== Why You Should Totally Use This
* Lower the risk of being a **Fashion Terrorist**.
* Recommendation of matching apparels with just a few commands given.
* Use the time spent for planning of matching apparels on something more productive.
* When you look good, you feel good.

== 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_.
* Libraries used: https://github.com/TestFX/TestFX[TextFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5]
* This project is modification of AddressBook-Level4 project created by SE-EDU initiative at https://github.com/se-edu/

== Licence : link:LICENSE[MIT]
2 changes: 1 addition & 1 deletion config/travis/check-line-endings.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Checks for prohibited line endings.
# Prohibited line endings: \r\n

git grep --cached -I -n --no-color -P '\r$' -- ':/' |
git grep --cached -I -n --no-colorValue -P '\r$' -- ':/' |
awk '
BEGIN {
FS = ":"
Expand Down
2 changes: 1 addition & 1 deletion config/travis/check-trailing-whitespace.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/sh
# Checks for trailing whitespace

git grep --cached -I -n --no-color -P '[ \t]+$' -- ':/' |
git grep --cached -I -n --no-colorValue -P '[ \t]+$' -- ':/' |
awk '
BEGIN {
FS = ":"
Expand Down
49 changes: 17 additions & 32 deletions docs/AboutUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,38 @@
: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} +
We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
AddressBook - Level 4 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team.

== 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>>]
=== Philip Garabandic
image::philipphil.png[width="150", align="left"]
{empty}[https://github.com/PhilipPhil[github]]

Role: Project Advisor
Role: Recommendation Algorithms Methods

'''

=== John Roe
image::lejolly.jpg[width="150", align="left"]
{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
=== Raffles Andrison
image::rafflesandrison.png[width="150", align="left"]
{empty}[http://github.com/rafflesandrison[github]]

Role: Team Lead +
Responsibilities: UI
Role: Organisation Methods

'''

=== Johnny Doe
image::yijinl.jpg[width="150", align="left"]
{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
=== Stanley Joseph Mok
image::stanleymok.png[width="150", align="left"]
{empty}[http://github.com/stanleymok[github]]

Role: Developer +
Responsibilities: Data
Role: Infrastructure Management Methods

'''

=== Johnny Roe
image::m133225.jpg[width="150", align="left"]
{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
=== Tan Yiren Eugene
image::reinsheer.png[width="150", align="left"]
{empty}[http://github.com/ReinSheer[github]]

Role: Developer +
Responsibilities: Dev Ops + Threading

'''

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

Role: Developer +
Responsibilities: UI
Role: Statistical Methods

'''
3 changes: 1 addition & 2 deletions docs/ContactUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@
:stylesDir: stylesheets

* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level4/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
* *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
* *Email us* : You can also reach us at `damith [at] comp.nus.edu.sg`
* *Email us* : You can also reach us at [email protected]
Loading