Skip to content

Commit 0e0c9e5

Browse files
Update README.md
1 parent 0aeeab9 commit 0e0c9e5

File tree

1 file changed

+43
-3
lines changed

1 file changed

+43
-3
lines changed

README.md

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,20 @@ TechBlogger is a modern, full-stack blogging platform designed for tech enthusia
66

77
- **User Dashboard**: Personalized dashboard for users to manage their posts, view analytics, and update their profile.
88
- **Admin Panel**: Powerful admin interface for managing users, admins, reports, and platform settings.
9-
- **API Key System**: Both users and admins can generate, view, and use API keys for secure API access.
9+
- **Role-Based Access Control**: Secure, protected routes for users and admins, with visual alerts and auto-redirects for unauthorized access.
10+
- **Pricing & Subscription Tiers**: Multiple plans (Basic, Starter, Professional, Enterprise) with feature comparison and modern pricing UI.
11+
- **API Key System**: Both users and admins can generate, view, and use API keys for secure API access, with copy/regenerate functionality and usage code snippets.
1012
- **Authentication**: Secure login system with role-based access control (user/admin).
1113
- **Post Management**: Create, edit, and delete blog posts. Users see their own posts; admins can manage all users.
1214
- **Analytics**: Visual charts and stats for both users and admins.
1315
- **Profile Customization**: Upload avatars, update bio, and manage account settings.
16+
- **Modern UI/UX**: Animated stats, feature cards, and improved CSS for a beautiful, responsive experience.
1417

1518
## 🛠️ Tech Stack
1619

17-
- **Frontend**: React.js (with Chart.js for analytics)
20+
- **Frontend**: React.js (with Chart.js, Recharts for analytics, Lucide React for icons)
1821
- **Backend**: Flask (Python) with RESTful API endpoints
19-
- **Database**: SQLite (default, can be swapped for MySQL/PostgreSQL)
22+
- **Database**: SQLite (default, can be swapped for MySQL)
2023
- **Styling**: Custom CSS
2124

2225
## 🧩 Architecture Overview
@@ -72,22 +75,59 @@ npm install
7275
```bash
7376
cd src/components
7477
pip install flask flask-cors
78+
# Or, if requirements.txt is present:
79+
# pip install -r requirements.txt
7580
```
7681

7782
### 4. Run the Backend
7883
```bash
7984
python app.py
8085
# or the relevant backend file
86+
# Backend runs on http://localhost:5000 by default
8187
```
8288

8389
### 5. Run the Frontend
8490
```bash
8591
cd ../..
8692
npm start
93+
# Frontend runs on http://localhost:3000 by default
94+
```
95+
96+
### 6. Build for Production
97+
```bash
98+
npm run build
99+
```
100+
101+
### 7. Run Tests
102+
```bash
103+
npm test
87104
```
88105

89106
The app will be available at [http://localhost:3000](http://localhost:3000).
90107

108+
## 🏷️ Pricing & Subscription Tiers
109+
110+
TechBlogger now offers multiple subscription plans:
111+
- **Basic**: Free access to public blog posts, community forum, newsletter, and analytics.
112+
- **Starter**: Adds web development consultation, more posts per month, and email support.
113+
- **Professional**: Advanced web development, priority support, 1-on-1 calls, and custom project planning.
114+
- **Enterprise**: Full-scale solutions, unlimited posts, dedicated support, and priority features.
115+
116+
Compare features and choose a plan in the **Services** section of the app.
117+
118+
## 🛡️ Role-Based Access Control
119+
120+
- **Protected Routes**: Only users with the correct role can access user/admin dashboards.
121+
- **Visual Alerts**: Unauthorized access triggers animated alerts and auto-redirects.
122+
- **Manual Redirect**: "Go Now" button for immediate navigation.
123+
- **Security**: All role checks are validated on both frontend and backend.
124+
125+
## 🏠 Enhanced Home & Community Features
126+
127+
- **Animated Stats**: See live stats for readers, articles, authors, and views.
128+
- **Featured Articles**: Curated list of trending and new articles.
129+
- **Community Support**: Connect with developers worldwide.
130+
91131
## 🏗️ Code Structure
92132

93133
```

0 commit comments

Comments
 (0)