From 645df2a93f49bfb3c5ed992924cf1ceafd4d6f4e Mon Sep 17 00:00:00 2001 From: hotungkhanh Date: Sun, 27 Oct 2024 20:11:16 +1100 Subject: [PATCH] docs: add sections to README according to lecture slides --- .github/workflows/main.yml | 2 +- README.md | 105 ++++++++++++++++++++++++++++++++++++- 2 files changed, 104 insertions(+), 3 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index c9efee5..dc9fb25 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,4 +1,4 @@ -name: CI/CD Pipeline +name: Deploy on: push: diff --git a/README.md b/README.md index 77c4aa7..834034b 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,84 @@
+## Demo -## Dependencies +https://vit-timetabling-230c1835ad5a.herokuapp.com + +
+ + +## Features + +
+ Login + + * +
+
+ Welcome Page + + * +
+
+ Upload File + + * +
+
+ Information Page + + * +
+
+ Generate Timetable + + * +
+
+ Display and Download Timetables + + * +
+ +
+ +## Documentation + +
+ User Stories + + * +
+
+ + Motivational Model +
+ +
+
+ + Domain Model +
+ +
+
+ + Flow Diagram +
+ +
+
+ + Architecture Diagram +
+ +
+ +
+ + +## System requirements Before cloning and attempting to run this code, you will need: @@ -21,7 +97,7 @@ Before cloning and attempting to run this code, you will need:
-## How to run the app +## Installation guide ### Running the frontend Move into the frontend folder with: @@ -64,6 +140,31 @@ Run in production mode:
+## Testing + +
+ User Stories + + * +
+
+ Domain Model + + * +
+
+ Flow Diagram + + * +
+
+ Architecture Diagram + + * +
+ +
+ ## Contributors