Skip to content

Commit 76f94af

Browse files
committed
Change Readme
1 parent 51240e4 commit 76f94af

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,54 +8,54 @@ Full-stack event management • AI-powered budgeting • Real-time analytics
88

99
---
1010

11-
## 🎯 What is this?
11+
## What is this?
1212

1313
EventStack is a comprehensive full-stack event management platform designed to connect event organizers with attendees. It provides a complete suite of tools for managing events, tracking expenses, discovering activities, and engaging with attendees through intelligent features.
1414

1515
Built with modern web technologies and best practices, EventStack offers a seamless experience for both event organizers and attendees, from event discovery to budget management.
1616

1717
---
1818

19-
## Key Features
19+
## Key Features
2020

21-
### 🔐 User Authentication
21+
### User Authentication
2222
- Secure registration and login for attendees and organizers
2323
- Role-based access control (Admin, Organizer, Attendee)
2424
- JWT-based authentication with secure token management
2525

26-
### 📅 Event Management
26+
### Event Management
2727
- Admins can create, update, and manage event listings
2828
- Rich event details with image uploads
2929
- Event categorization and filtering
3030
- Venue management
3131

32-
### 🔍 Event Discovery
32+
### Event Discovery
3333
- Advanced search functionality
3434
- Browse and filter events by category, date, and location
3535
- Detailed event information pages
3636
- Bookmark favorite events
3737

38-
### 💰 Expense Tracking
38+
### Expense Tracking
3939
- Organizers can manage event budgets
4040
- Track expenses with detailed records
4141
- Budget analysis and reporting
4242
- Financial dashboard for organizers
4343

44-
### 🤖 AI-Powered Budget Bot
44+
### AI-Powered Budget Bot
4545
- Intelligent assistant for budget planning
4646
- Real-time budget recommendations
4747
- Integration with Google Gemini API
4848
- Smart expense categorization
4949

50-
### 📊 Admin & Organizer Dashboards
50+
### Admin & Organizer Dashboards
5151
- Dedicated interfaces for managing events
5252
- Financial overview and analytics
5353
- User management capabilities
5454
- Complete system control
5555

5656
---
5757

58-
## 🏗️ How It Works
58+
## How It Works
5959

6060
### System Architecture
6161

@@ -82,7 +82,7 @@ Built with modern web technologies and best practices, EventStack offers a seaml
8282

8383
---
8484

85-
## 💻 Technology Stack
85+
## Technology Stack
8686

8787
| Component | Technology |
8888
|-----------|-----------|
@@ -101,7 +101,7 @@ Built with modern web technologies and best practices, EventStack offers a seaml
101101

102102
---
103103

104-
## 🚀 Quick Start
104+
## Quick Start
105105

106106
### One Command Deployment
107107

@@ -120,9 +120,9 @@ Built with modern web technologies and best practices, EventStack offers a seaml
120120

121121
### Access Your System
122122

123-
- 🌐 **Frontend**: http://localhost:5173
124-
- 🔌 **Backend API**: http://localhost:4000
125-
- 💾 **Database**: localhost:5432
123+
- **Frontend**: http://localhost:5173
124+
- **Backend API**: http://localhost:4000
125+
- **Database**: localhost:5432
126126

127127
**Automatic Cleanup**: Press `ENTER` when finished to stop all services, close windows, and optionally drop the database (unless `CTRL+C` is pressed to keep the database).
128128

@@ -168,31 +168,31 @@ Built with modern web technologies and best practices, EventStack offers a seaml
168168
.\deploy-eventstack.ps1 -DbPassword "SecurePass" -JwtSecret "MySecretKey" -BackendPort 8080 -LoadSampleData
169169
```
170170

171-
📖 **Need more details?** Check the deployment guide for all available parameters and options.
171+
**Need more details?** Check the deployment guide for all available parameters and options.
172172

173173
---
174174

175-
## 📊 System Highlights
175+
## System Highlights
176176

177-
**Production Ready** - Fully tested and deployment-ready
177+
**Production Ready** - Fully tested and deployment-ready
178178

179-
🧪 **Comprehensive Testing** - 60+ test files covering unit and integration tests
179+
**Comprehensive Testing** - 60+ test files covering unit and integration tests
180180

181-
📈 **High Code Coverage** - 89%+ coverage across frontend and backend
181+
**High Code Coverage** - 89%+ coverage across frontend and backend
182182

183-
🔒 **Secure** - JWT authentication, password hashing, input validation
183+
**Secure** - JWT authentication, password hashing, input validation
184184

185-
🎨 **Modern UI** - Responsive design for mobile and desktop
185+
**Modern UI** - Responsive design for mobile and desktop
186186

187-
**Fast & Efficient** - Fastify backend, Vite frontend build
187+
**Fast & Efficient** - Fastify backend, Vite frontend build
188188

189-
🔧 **Easy Setup** - Single-script automated deployment
189+
**Easy Setup** - Single-script automated deployment
190190

191-
📝 **Type Safe** - Full TypeScript implementation
191+
**Type Safe** - Full TypeScript implementation
192192

193193
---
194194

195-
## 🧪 Running Tests
195+
## Running Tests
196196

197197
Both packages are equipped with comprehensive test suites using Vitest.
198198

@@ -230,7 +230,7 @@ Coverage reports are generated in the `coverage/` directory, and PDF reports are
230230

231231
---
232232

233-
## 📂 Project Structure
233+
## Project Structure
234234

235235
```
236236
eventstack/
@@ -249,7 +249,7 @@ eventstack/
249249

250250
---
251251

252-
## 🔧 Manual Setup
252+
## Manual Setup
253253

254254
If you prefer to set up the project manually or are on a non-Windows system:
255255

@@ -316,7 +316,7 @@ If you prefer to set up the project manually or are on a non-Windows system:
316316
---
317317

318318

319-
## 🏛️ Academic Context
319+
## Academic Context
320320

321321
**Course**: Computer Engineering Project
322322
**Institution**: University of Peradeniya

0 commit comments

Comments
 (0)