Skip to content

Commit

Permalink
docs: add sections to README according to lecture slides
Browse files Browse the repository at this point in the history
  • Loading branch information
hotungkhanh committed Oct 27, 2024
1 parent a736554 commit 645df2a
Show file tree
Hide file tree
Showing 2 changed files with 104 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: CI/CD Pipeline
name: Deploy

on:
push:
Expand Down
105 changes: 103 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,84 @@

<hr/>

## Demo

## Dependencies
https://vit-timetabling-230c1835ad5a.herokuapp.com

<br/>


## Features

<details>
<summary>Login</summary>

*
</details>
<details>
<summary>Welcome Page</summary>

*
</details>
<details>
<summary>Upload File</summary>

*
</details>
<details>
<summary>Information Page</summary>

*
</details>
<details>
<summary>Generate Timetable</summary>

*
</details>
<details>
<summary>Display and Download Timetables</summary>

*
</details>

<br/>

## Documentation

<details>
<summary>User Stories</summary>

*
</details>
<details>

<summary>Motivational Model</summary>
<img src="docs\Motivational Model.png"/><br/>

</details>
<details>

<summary>Domain Model</summary>
<img src="docs\Domain Model.png"/><br/>

</details>
<details>

<summary>Flow Diagram</summary>
<img src="docs\Flow Diagram.png"/><br/>

</details>
<details>

<summary>Architecture Diagram</summary>
<img src="docs\Architecture Diagram.png"/><br/>

</details>

<br/>


## System requirements

Before cloning and attempting to run this code, you will need:

Expand All @@ -21,7 +97,7 @@ Before cloning and attempting to run this code, you will need:

<br/>

## How to run the app
## Installation guide

### Running the frontend
Move into the frontend folder with:
Expand Down Expand Up @@ -64,6 +140,31 @@ Run in production mode:

<br/>

## Testing

<details>
<summary>User Stories</summary>

*
</details>
<details>
<summary>Domain Model</summary>

*
</details>
<details>
<summary>Flow Diagram</summary>

*
</details>
<details>
<summary>Architecture Diagram</summary>

*
</details>

<br/>

## Contributors

<a href="https://github.com/dh-giang-vu">
Expand Down

0 comments on commit 645df2a

Please sign in to comment.