Skip to content

Commit 5511696

Browse files
committed
docs
1 parent 6bf9241 commit 5511696

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

documentation/ARCHITECTURE_DOCUMENTATION.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ DefiFundr is a decentralized payroll and invoice management system built on the
1616

1717
Below is a high-level architecture diagram of the DefiFundr system:
1818

19-
![DefiFundr Architecture Diagram]()
19+
![DefiFundr Architecture Diagram](https://github.com/chiscookeke11/defifundr_backend--fork--/blob/main/documentation/images/DefiFundr%20Architecture%20Documentation%20-%20visual%20selection.png?raw=true)
2020

2121

2222
---
@@ -98,30 +98,29 @@ Below is a high-level architecture diagram of the DefiFundr system:
9898

9999
6. **Response**:
100100
- The backend sends a response back to the frontend, which updates the UI accordingly.
101-
101+
102+
![Frontend Architecture Diagram](https://github.com/chiscookeke11/defifundr_backend--fork--/blob/main/documentation/images/dataflow.png?raw=true)
102103
---
103104

104105
## Detailed Component Diagrams
105106

106107
### 1. **Frontend Architecture**
107-
![Frontend Architecture Diagram](https://via.placeholder.com/800x600.png?text=Frontend+Architecture+Diagram)
108+
108109

109110
- **Components**:
110111
- **UI Layer**: React.js (Web), Dart (Mobile).
111112
- **State Management**: Redux (Web), Provider (Mobile).
112113
- **API Layer**: Axios (Web), Dio (Mobile).
113114

114115
### 2. **Backend Architecture**
115-
![Backend Architecture Diagram](https://via.placeholder.com/800x600.png?text=Backend+Architecture+Diagram)
116+
116117

117118
- **Components**:
118119
- **API Layer**: RESTful APIs built with Go/Node.js.
119120
- **Service Layer**: Handles business logic (e.g., campaign management, user authentication).
120121
- **Data Layer**: PostgreSQL (relational data), MongoDB (NoSQL data).
121122

122123
### 3. **Blockchain Architecture**
123-
![Blockchain Architecture Diagram](https://via.placeholder.com/800x600.png?text=Blockchain+Architecture+Diagram)
124-
125124
- **Components**:
126125
- **Smart Contracts**: Written in Solidity.
127126
- **Ethereum Network**: Mainnet or Testnet (e.g., Sepolia).
@@ -164,6 +163,10 @@ Below is a high-level architecture diagram of the DefiFundr system:
164163
### 5. **Storage**:
165164
- IPFS for decentralized file storage.
166165

166+
167+
168+
![Blockchain Architecture Diagram](https://github.com/chiscookeke11/defifundr_backend--fork--/blob/main/documentation/images/deployment-architceture.png?raw=true)
169+
167170
---
168171

169172
## Future Enhancements
@@ -206,9 +209,8 @@ DefiFundr is a decentralized payroll and invoice management system built on the
206209

207210
Below is a high-level architecture diagram of the DefiFundr system:
208211

209-
![DefiFundr Architecture Diagram](https://via.placeholder.com/800x600.png?text=DefiFundr+Architecture+Diagram)
210212

211-
*(Replace the placeholder link with an actual diagram. You can use tools like [Lucidchart](https://www.lucidchart.com/), [Draw.io](https://app.diagrams.net/), or [Miro](https://miro.com/) to create the diagram.)*
213+
212214

213215
---
214216

@@ -295,23 +297,20 @@ Below is a high-level architecture diagram of the DefiFundr system:
295297
## Detailed Component Diagrams
296298

297299
### 1. **Frontend Architecture**
298-
![Frontend Architecture Diagram](https://via.placeholder.com/800x600.png?text=Frontend+Architecture+Diagram)
299300

300301
- **Components**:
301302
- **UI Layer**: React.js (Web), Flutter (Mobile).
302303
- **State Management**: Redux (Web), Provider (Mobile).
303304
- **API Layer**: Axios (Web), Dio (Mobile).
304305

305306
### 2. **Backend Architecture**
306-
![Backend Architecture Diagram](https://via.placeholder.com/800x600.png?text=Backend+Architecture+Diagram)
307307

308308
- **Components**:
309309
- **API Layer**: RESTful APIs built with Go/Node.js.
310310
- **Service Layer**: Handles business logic (e.g., campaign management, user authentication).
311311
- **Data Layer**: PostgreSQL (relational data), MongoDB (NoSQL data).
312312

313313
### 3. **Blockchain Architecture**
314-
![Blockchain Architecture Diagram](https://via.placeholder.com/800x600.png?text=Blockchain+Architecture+Diagram)
315314

316315
- **Components**:
317316
- **Smart Contracts**: Written in Solidity.

0 commit comments

Comments
 (0)