Skip to content

Commit 8b383d3

Browse files
Readme updated for summary and key features removed
1 parent 65ac19d commit 8b383d3

File tree

1 file changed

+36
-54
lines changed

1 file changed

+36
-54
lines changed

README.md

Lines changed: 36 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A centralized error logging and monitoring API built with **.NET 9**, Entity Framework Core, and SQL Server. This project is designed to serve as a foundation for collecting, storing, and managing error logs from multiple applications. **Phase 5,7&8** have also been complated and the pending **Phase 6** will be developed in a new repository.
44

5-
Each phase is preserved in its own branch, but this repository now focuses on the above highlighted phases i.e. the final **Integration Portal, a Microservices influenced architechture (Single Service Database Pattern)**.
5+
Each phase of development is preserved in its own branch, culminating in the final **Integration Portal,** which, together with the API projects, forms a **Microservices-inspired architechture** that demonstrates **the Single Service Database Pattern.**
66

77
---
88

@@ -14,59 +14,6 @@ A **.NET 9 MVC Web App** that unifies multiple APIs (**User Management and Loggi
1414

1515
---
1616

17-
## 🔑 Key Features
18-
19-
- ✅ A login page with client and server side validations
20-
21-
- ✅ There are two users for login.
22-
23-
- ✅ User name and passwords of the two are alice/alice and bob/bob.
24-
25-
- ✅ Alice is admin and bob is an operations user.
26-
27-
- ✅ Serilog + file sinks implemented for the web app.
28-
29-
- ✅ Invalid user error is posted to the Error logging API
30-
31-
- ✅ When user logins successfully a cotegort tree is generated on the sidebar
32-
33-
- ✅ Only logs link from the side bar work with the logout feature.
34-
35-
- ✅ Admin user can view logs
36-
37-
---
38-
39-
## 📊 Architecture Glimpse
40-
41-
![Integration Portal Architecture](docs/integration_portal_architecture.png)
42-
<sub>[View Mermaid source](docs/integration_portal_architecture.mmd)</sub>
43-
44-
---
45-
46-
### 📸 Screenshots
47-
48-
### 🔑 Login Page
49-
50-
![Login Page](docs/screenshots/login.png)
51-
52-
### 📂 Home & Sidebar
53-
54-
![Sidebar Tree](docs/screenshots/home%20and%20sidebar.png)
55-
56-
### 📊 Logs (Admin View)
57-
58-
![Logs Page](docs/screenshots/logs%20view.png)
59-
60-
## 📡 API Swagger UI
61-
62-
**User Management API**
63-
64-
![User API Swagger](docs/screenshots/usermanagementapi.png)
65-
66-
**Centralized Error Logging API**
67-
68-
![Logging API Swagger](docs/screenshots/centralizedloggingapi.png)
69-
7017
## ⚙️ Implementation Details
7118

7219
- **Login & Validation**
@@ -131,10 +78,45 @@ A **.NET 9 MVC Web App** that unifies multiple APIs (**User Management and Loggi
13178

13279
- Ensures secure re-authentication before accessing APIs again.
13380

81+
---
82+
83+
## 📊 Architecture Glimpse
84+
85+
![Integration Portal Architecture](docs/integration_portal_architecture.png)
86+
<sub>[View Mermaid source](docs/integration_portal_architecture.mmd)</sub>
87+
88+
---
89+
90+
### 📸 Screenshots
91+
92+
### 🔑 Login Page
93+
94+
![Login Page](docs/screenshots/login.png)
95+
96+
### 📂 Home & Sidebar
97+
98+
![Sidebar Tree](docs/screenshots/home%20and%20sidebar.png)
99+
100+
### 📊 Logs (Admin View)
101+
102+
![Logs Page](docs/screenshots/logs%20view.png)
103+
104+
## 📡 API Swagger UI
105+
106+
**User Management API**
107+
108+
![User API Swagger](docs/screenshots/usermanagementapi.png)
109+
110+
**Centralized Error Logging API**
111+
112+
![Logging API Swagger](docs/screenshots/centralizedloggingapi.png)
113+
134114
---
135115

136116
## 🏗️ Planned Enhancements (Next Repository)
137117

118+
119+
138120
The next repository will focus on:
139121

140122
- **Centralized Authorization Layer/Handler**

0 commit comments

Comments
 (0)