Skip to content

Commit a7a95bc

Browse files
committed
Add developer and user guide for ease of tracking and collaboration
1 parent 25caa15 commit a7a95bc

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

Developer-Guide.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Devloper's Guide
2+
3+
This guide contains all the commands and set-up information to contribute to the repository.
4+
5+
For more information about the different microservice, please read the respective `README.md` in the different micro services.
6+
7+
## Commands Available to run from Root Repo
8+
9+
Currently Still **Work in Progress**, will add after setting up Package.json in Root.
10+
11+
## Main Layout of the Repository
12+
13+
## Ports Used by the different Microservices
14+
15+
### Micro Frontend
16+
17+
**Container App** - Main PeerPrep app
18+
19+
- **Location**: `ui-shell/`
20+
- **Port**: 5173
21+
22+
**Matching Micro Frontend**
23+
24+
- **Location**: `ui-services/matching-ui-service/`
25+
- **Port**: 5174
26+
27+
**Questions Micro Frontend**
28+
29+
- **Location**: `ui-services/questions-ui-service/`
30+
- **Port**: 5175
31+
32+
**Collaboration Micro Frontend**
33+
34+
- **Location**: `ui-services/collab-ui-service/`
35+
- **Port**: 5176
36+
37+
**User Micro Frontend**
38+
39+
- **Location**: `ui-services/user-ui-service/`
40+
- **Port**: 5177
41+
42+
**History Micro Frontend**
43+
44+
- **Location**: `ui-services/history-ui-service/`
45+
- **Port**: 5178
46+
47+
### Micro Backend
48+
49+
**Question Micro Backend**
50+
51+
- **Location**: `backend-services/question-backend-service/`
52+
- **Port**: 5275

User-Guide.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# User's Guide
2+
3+
This guide contains the instructions to run the application.
4+
5+
<!-- Add details after user of Orchestrator to organise the different microservice packages in GitHub. -->

0 commit comments

Comments
 (0)