Skip to content

Commit 7259d8c

Browse files
committed
Update README.md
1 parent aa7f32c commit 7259d8c

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## 📑 Index
66

7-
- [Resume]
7+
- [1. Resume](#1 )
88
- [1. Company Overview](#1-company-overview)
99
- [2. Objectives](#2-objectives)
1010
- [3. Target Audience](#3-target-audience)
@@ -21,7 +21,7 @@
2121

2222
---
2323

24-
## 1. Company Overview
24+
## 2. Company Overview
2525

2626
**Company Name:** *Malta Brew, Taproom*
2727

@@ -35,7 +35,7 @@
3535

3636
---
3737

38-
## 2. Objectives
38+
## 3. Objectives
3939

4040
Malta Brew, Taproom aims to evolve beyond a taproom into a vibrant cultural hub.
4141

@@ -47,13 +47,13 @@ Malta Brew, Taproom aims to evolve beyond a taproom into a vibrant cultural hub.
4747

4848
---
4949

50-
## 3. Target Audience
50+
## 4. Target Audience
5151

5252
The establishment welcomes individuals aged **18 and above**, of any nationality, who appreciate gastronomic and cultural experiences tied to craft beer.
5353

5454
---
5555

56-
## 4. Why an Information System (IS) Matters
56+
## 5. Why an Information System (IS) Matters
5757

5858
An integrated Information System is essential for achieving operational excellence and strategic growth:
5959

@@ -66,7 +66,7 @@ An integrated Information System is essential for achieving operational excellen
6666

6767
---
6868

69-
## 5. Mission & Core Values
69+
## 6. Mission & Core Values
7070

7171
### Mission
7272

@@ -83,7 +83,7 @@ Deliver exceptional, discovery-rich experiences centered on Portuguese craft bee
8383

8484
---
8585

86-
## 6. Team Structure & User Roles
86+
## 7. Team Structure & User Roles
8787

8888
### Organizational Structure
8989

@@ -101,7 +101,7 @@ Deliver exceptional, discovery-rich experiences centered on Portuguese craft bee
101101
| Management | Internal, Full | Control across clients, events, products, and operations |
102102
| Employees | Internal, Limited | Access to clients, events, and products (day-to-day tasks) |
103103

104-
## 7. Functional Requirements
104+
## 8. Functional Requirements, Non-Functional Requirements and Others
105105

106106
### 👤 For the Customer
107107

@@ -158,7 +158,7 @@ Deliver exceptional, discovery-rich experiences centered on Portuguese craft bee
158158

159159
---
160160

161-
## 3. Non-Functional Requirements
161+
### Non-Functional Requirements
162162

163163
- NFR01: **Security** – Sensitive data encryption, permission management, payment security.
164164
- NFR02: **Usability** – Intuitive interface, multilingual, accessible via app and kiosk.
@@ -169,7 +169,7 @@ Deliver exceptional, discovery-rich experiences centered on Portuguese craft bee
169169

170170
---
171171

172-
## 4. Technical Constraints
172+
### Technical Constraints
173173

174174
- TC01: Central database in **SQLite**.
175175
- TC02: Native integration with cashless terminals (own or via API).
@@ -178,7 +178,7 @@ Deliver exceptional, discovery-rich experiences centered on Portuguese craft bee
178178

179179
---
180180

181-
## 5. Reports & Audit
181+
### Reports & Audit
182182

183183
- RA01: Complete listings by period: sales, customers, products.
184184
- RA02: Real-time stock reports.
@@ -187,19 +187,19 @@ Deliver exceptional, discovery-rich experiences centered on Portuguese craft bee
187187

188188
---
189189

190-
## 6. Special Rules & Notes
190+
### Special Rules & Notes
191191

192192
- SR01: Integrate general stock: consumption automatically reduces stock.
193193
- SR02: Independent modules with communication between areas (customers, suppliers, products, events).
194194
- SR03: Easy maintenance and future updates.
195195

196-
### System Entities - Malta Brew Taproom
196+
## 9. System Entities - Malta Brew Taproom
197197

198198
This document describes the main entities of the system and their respective attributes, based on the relational model in SQLite.
199199

200200
---
201201

202-
#### 📌 Customer
202+
### 📌 Customer
203203

204204
```sql
205205
Clients (
@@ -217,7 +217,7 @@ Clients (
217217
);
218218
```
219219

220-
#### 🍺 Product
220+
### 🍺 Product
221221

222222
```sql
223223
Products (
@@ -233,7 +233,7 @@ Products (
233233
);
234234
```
235235

236-
#### 👨‍🔧 Employee
236+
### 👨‍🔧 Employee
237237

238238
```sql
239239
Employees (
@@ -252,7 +252,7 @@ Employees (
252252
);
253253
```
254254

255-
#### 🏭 Supplier
255+
### 🏭 Supplier
256256

257257
```sql
258258
Suppliers (
@@ -269,7 +269,7 @@ Suppliers (
269269
);
270270
```
271271

272-
#### ⭐ Review
272+
### ⭐ Review
273273

274274
```sql
275275
Reviews (
@@ -281,7 +281,7 @@ Reviews (
281281
);
282282
```
283283

284-
#### 🎉 Events
284+
### 🎉 Events
285285

286286
```sql
287287
Events (
@@ -300,7 +300,7 @@ Events (
300300
);
301301
```
302302

303-
#### 🎉 Event Participation
303+
### 🎉 Event Participation
304304

305305
```sql
306306
Event_participation (
@@ -310,7 +310,7 @@ Event_participation (
310310
);
311311
```
312312

313-
#### 💳 Payments
313+
### 💳 Payments
314314

315315
```sql
316316
Payments (
@@ -325,7 +325,7 @@ Payments (
325325
);
326326
```
327327

328-
#### 💳 Payment_Items
328+
### 💳 Payment_Items
329329

330330
```sql
331331
Payment_items (
@@ -336,7 +336,7 @@ Payment_items (
336336
);
337337
```
338338

339-
#### 📦 Order
339+
### 📦 Order
340340

341341
```sql
342342
Orders (
@@ -353,7 +353,7 @@ Orders (
353353
);
354354
```
355355

356-
#### 📦 Order Items
356+
### 📦 Order Items
357357

358358
```sql
359359
Order_items (

0 commit comments

Comments
 (0)