Skip to content

Commit 22d33c2

Browse files
committed
Added phase 2 presentation guide
1 parent 13f8467 commit 22d33c2

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

docs/presentation-guide.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Phase 2 Presentation Guide
2+
3+
This document presents a summary of the presentation.
4+
The steps below are organized in chronological order.
5+
6+
## Browser Demonstration
7+
1. Demonstrate login page, failing at least once
8+
2. After login, show browser local storage
9+
3. Describe general application layout (navbar and content)
10+
4. Demonstrate project functionalities (list, create, details, edit)
11+
5. Try creating an issue without a start state
12+
6. List states, emphasis on `closed` and `archived` state (can't edit or remove and `closed` has a transition to `archived`)
13+
7. Create a start state, demonstrate state functionalities (edit, delete, change state), add transition to `closed` state
14+
8. Show network requests on browser when searching states
15+
9. Create issue with start state, demonstrate issue functionalities
16+
10. Demonstrate issue comments functionalities (create, details, edit)
17+
11. Fill issue comments to show pagination support
18+
12. Bookmark to show deep-linking support
19+
13. Close issue (show close date), and archive (show comments)
20+
14. Demonstrate label functionalities (create, add to issue)
21+
15. Delete project, try accessing bookmark (404)
22+
16. Demonstrate users page
23+
17. Log-out, try to access a page that requires authentication
24+
25+
## Code Structure Demonstration
26+
1. Show directories organization
27+
2. Show App start-up code
28+
3. Demonstrate [fetchRoutes](../code/js/src/main/api/apiRoutes.ts), emphasize hypermedia support and error handling
29+
4. Describe how credentials are stored and managed through [userSession](../code/js/src/main/utils/userSession.ts) and [LoginPage](../code/js/src/main/components/LoginPage.tsx)
30+
5. Show overview of routes, explaining how the app supports deep-linking (through react-router)
31+
6. Demonstrate [ProjectsPage](../code/js/src/main/components/projects/ProjectsPage.tsx), explaining how the component state is managed and how the API response changes the component structure based on the presence of an `action`
32+
7. Show [CreateProject](../code/js/src/main/components/projects/CreateProject.tsx), demonstrate how the form works and how the API requests are made
33+
8. Demonstrate [Paginated](../code/js/src/main/components/Paginated.tsx)

0 commit comments

Comments
 (0)