Skip to content

Commit 193d081

Browse files
authored
Update README.md
1 parent 9c127fe commit 193d081

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ DevTaskFlow is a task management application built with Angular and Node.js, fea
1010
- Task priority system (Low, Medium, High)
1111
- Task filtering by completion status, priority, and overdue deadlines
1212
- Task sorting by date and priority
13+
- Task searching
1314
- Pinned tasks feature
1415
- Pagination for tasks
1516

@@ -26,9 +27,18 @@ DevTaskFlow is a task management application built with Angular and Node.js, fea
2627

2728
- Angular Material design
2829
- Responsive UI with dynamic theme switching
30+
- Dark/White mode toggle
2931
- Form validation with proper error handling
3032
- Preloaders for login, registration, and password recovery
3133
- Confirmation dialogs for critical actions (e.g., deleting all tasks)
34+
- Navigation Menu for better usability
35+
36+
### ✅ Automated Testing & CI/CD
37+
38+
- **Unit Testing:** Jasmine & Karma for frontend unit tests
39+
- **Continuous Integration:** GitHub Actions runs automated unit tests
40+
- **Deployment Checks:** Vercel deploys only if tests pass
41+
- **Test Reports:** JUnit reports uploaded to GitHub Actions
3242

3343
## Tech Stack
3444

@@ -37,6 +47,7 @@ DevTaskFlow is a task management application built with Angular and Node.js, fea
3747
- **Authentication:** JWT, bcrypt.js
3848
- **Email Service:** Nodemailer with AOL SMTP
3949
- **Hosting:** Vercel (Frontend), Render (Backend)
50+
- **Testing & CI/CD:** Jasmine, Karma, GitHub Actions
4051

4152
## Installation & Setup
4253

@@ -53,11 +64,11 @@ DevTaskFlow is a task management application built with Angular and Node.js, fea
5364
```
5465
3. Create a `.env` file in the root directory and add:
5566
```env
56-
PORT=3000
5767
MONGO_URI=your-mongodb-connection-string
5868
JWT_SECRET=your-secret-key
5969
EMAIL_USER=your-email@example.com
6070
EMAIL_PASS=your-email-password
71+
PORT=3000
6172
```
6273
4. Start the server:
6374
```sh
@@ -86,6 +97,7 @@ DevTaskFlow is a task management application built with Angular and Node.js, fea
8697

8798
- **Frontend:** Hosted on Vercel at [https://dev-task-flow.vercel.app](https://dev-task-flow.vercel.app)
8899
- **Backend:** Hosted on Render at [https://dev-task-flow-auth-server.onrender.com](https://dev-task-flow-auth-server.onrender.com)
100+
- **GitHub Actions:** Runs unit tests before deployment
89101

90102
## Routes
91103

@@ -95,8 +107,12 @@ DevTaskFlow is a task management application built with Angular and Node.js, fea
95107
| ------ | ------------------ | --------------------------------- |
96108
| `POST` | `/register` | Register a new user |
97109
| `POST` | `/login` | Login user & return JWT |
98-
| `GET` | `/profile` | Get user profile (protected) |
99110
| `POST` | `/forgot-password` | Send a new password to user email |
111+
| `GET` | `/tasks` | Fetch all tasks for the user |
112+
| `POST` | `/tasks` | Create a new task |
113+
| `PUT` | `/tasks/:taskId` | Update a task by ID |
114+
| `DELETE` | `/tasks/:taskId` | Delete a task by ID |
115+
| `DELETE` | `/tasks` | Delete all tasks for the user |
100116

101117
### Frontend Routes
102118

@@ -107,16 +123,10 @@ DevTaskFlow is a task management application built with Angular and Node.js, fea
107123
| `/register` | RegisterComponent | User registration page |
108124
| `/forgot-password` | ForgotPasswordComponent | Password reset page |
109125

110-
## Future Improvements
111-
112-
- Menu
113-
- Dark/White mode toggle
114-
115126
## Contributing
116127

117128
Pull requests are welcome! Please ensure your changes align with the existing architecture and maintain code quality.
118129

119130
## License
120131

121132
This project is licensed under the MIT License.
122-

0 commit comments

Comments
 (0)