forked from se-edu/addressbook-level3
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This project uses AsciiDoc for doucmentation. The courses that use this project no longer needs section numbering and content inclusion features in documentation. That opens the door for going back to Markdown, which is more widely used and simpler. This project also uses Travis/AppVeyor for CI. With the recent release of GitHub Actions, there is no need to depend on external CI services. Let's do the following changes: * Migrate documentation from AsciiDoc to Markdown, and use Jekyll to generate the project website. The migration was done mostly by @j-lum, with minor cosmetic/content tweaks added by @damithc * Migrate to GitHub Actions (from Travis and AppVeyor). As a side-effect, we have to drop support for Coveralls, because the current Coveralls set up depends on Travis. We expect to bring back Coverall support in future. We decided to do both major changes at the same time in order to avoid some overlaps, and also snuck in some documentation tweaks because almost every documentation line is touched by the asciidoc to Markdown conversion anyway.
- Loading branch information
damithc
committed
May 22, 2020
1 parent
edad552
commit 0be83b2
Showing
79 changed files
with
3,092 additions
and
3,627 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
name: Java CI | ||
|
||
on: [push, pull_request] | ||
|
||
jobs: | ||
build: | ||
strategy: | ||
matrix: | ||
platform: [ubuntu-latest, macos-latest, windows-latest] | ||
runs-on: ${{ matrix.platform }} | ||
|
||
steps: | ||
- name: Set up repository | ||
uses: actions/checkout@master | ||
|
||
- name: Set up repository | ||
uses: actions/checkout@master | ||
with: | ||
ref: master | ||
|
||
- name: Merge to master | ||
run: git checkout --progress --force ${{ github.sha }} | ||
|
||
- name: Validate Gradle Wrapper | ||
uses: gradle/wrapper-validation-action@v1 | ||
|
||
- name: Setup JDK 11 | ||
uses: actions/setup-java@v1 | ||
with: | ||
java-version: '11' | ||
java-package: jdk+fx | ||
|
||
- name: Build and check with Gradle | ||
run: ./gradlew check |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,3 +19,4 @@ src/test/data/sandbox/ | |
|
||
# MacOS custom attributes files created by Finder | ||
.DS_Store | ||
docs/_site/ |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/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. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
layout: page | ||
title: About Us | ||
--- | ||
|
||
_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ | ||
|
||
We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg). | ||
|
||
## Project Team | ||
|
||
### John Doe | ||
|
||
<img src="images/damithc.jpg" width="200px"> | ||
|
||
[[homepage](http://www.comp.nus.edu.sg/~damithch)] | ||
[[github](https://github.com/damithc)] | ||
[[portfolio](team/johndoe.md)] | ||
|
||
* Role: Project Advisor | ||
|
||
### John Roe | ||
|
||
<img src="images/lejolly.jpg" width="200px"> | ||
|
||
[[github](http://github.com/lejolly)] | ||
[[portfolio](team/johndoe.md)] | ||
|
||
* Role: Team Lead | ||
* Responsibilities: UI | ||
|
||
### Johnny Doe | ||
|
||
<img src="images/yijinl.jpg" width="200px"> | ||
|
||
[[github](http://github.com/yijinl)] [[portfolio](team/johndoe.md)] | ||
|
||
* Role: Developer | ||
* Responsibilities: Data | ||
|
||
### Johnny Roe | ||
|
||
<img src="images/m133225.jpg" width="200px"> | ||
|
||
[[github](http://github.com/m133225)] | ||
[[portfolio](team/johndoe.md)] | ||
|
||
* Role: Developer | ||
* Responsibilities: Dev Ops + Threading | ||
|
||
### Benson Meier | ||
|
||
<img src="images/yl_coder.jpg" width="200px"> | ||
|
||
[[github](http://github.com/yl-coder)] | ||
[[portfolio](team/johndoe.md)] | ||
|
||
* Role: Developer | ||
* Responsibilities: UI |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.