Skip to content

Commit 885e2bb

Browse files
authored
Remove various sections from README.md
Removed sections on key components, file upload configuration, data flow, and troubleshooting from the README.
1 parent b753c03 commit 885e2bb

File tree

1 file changed

+0
-49
lines changed

1 file changed

+0
-49
lines changed

README.md

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -203,16 +203,6 @@ class TaskFlowEnterprise {
203203
}
204204
```
205205

206-
### Key Components
207-
- **Login System** - Secure authentication flow
208-
- **Dashboard** - Real-time metrics and recent activities
209-
- **Task Manager** - CRUD operations with filtering
210-
- **User Management** - Role-based user administration
211-
- **File Storage** - Secure file handling
212-
- **Analytics** - Data visualization with Chart.js
213-
214-
---
215-
216206
## Configuration
217207

218208
### Environment Setup
@@ -226,25 +216,6 @@ app.use(rateLimit({
226216
windowMs: 15 * 60 * 1000, // 15 minutes
227217
max: 100 // limit each IP to 100 requests per windowMs
228218
}));
229-
```
230-
231-
### File Upload Configuration
232-
```javascript
233-
const upload = multer({
234-
storage: multer.diskStorage({
235-
destination: 'uploads/',
236-
filename: (req, file, cb) => {
237-
const uniqueName = Date.now() + '-' + file.originalname;
238-
cb(null, uniqueName);
239-
}
240-
}),
241-
limits: { fileSize: 50 * 1024 * 1024 }, // 50MB
242-
fileFilter: (req, file, cb) => {
243-
// Validate file types
244-
cb(null, true);
245-
}
246-
});
247-
```
248219

249220
## Security Implementation
250221

@@ -276,20 +247,6 @@ const passwordHash = await bcrypt.hash(password, 12);
276247
const validPassword = await bcrypt.compare(password, user.password_hash);
277248
```
278249

279-
## Data Flow
280-
281-
### Task Creation Flow
282-
1. User submits task form → Frontend validation
283-
2. POST /api/tasks → Backend validation
284-
3. Database insertion → Success response
285-
4. Frontend updates UI → Activity log entry
286-
287-
### File Upload Flow
288-
1. User selects file → Frontend validation
289-
2. POST /api/files/upload → Multer processing
290-
3. File metadata storage → Permission check
291-
4. Success response → UI update
292-
293250
## Deployment
294251

295252
### Production Setup
@@ -330,8 +287,6 @@ npm start
330287
- JWT tokens for stateless authentication
331288
- Rate limiting prevents abuse
332289

333-
## Troubleshooting
334-
335290
### Common Issues
336291
- **Database locks**: Ensure proper connection handling
337292
- **File upload fails**: Check uploads directory permissions
@@ -342,7 +297,3 @@ npm start
342297
- Activity logs track all user actions
343298
- Error logging to console
344299
- Performance metrics available
345-
346-
<br>
347-
348-
![Image](https://i.imgur.com/x1yHK9M.png)

0 commit comments

Comments
 (0)