Skip to content

Commit 27fa149

Browse files
committed
readme.md file updated
1 parent 8e6eda2 commit 27fa149

2 files changed

Lines changed: 44 additions & 25 deletions

File tree

README.md

Lines changed: 44 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ A modern web-based task management system built with Django and Tailwind CSS.
1010
![Built with Django](https://img.shields.io/badge/Built_with-Django-green?logo=django&logoColor=white)
1111
![Built with Tailwind](https://img.shields.io/badge/Styled_with-TailwindCSS-blue?logo=tailwindcss)
1212

13+
## 📌 About
14+
15+
**TaskNest** is a full-featured task management system designed for teams and individuals to collaborate efficiently. Built with Django and Tailwind CSS, it supports user roles, project/task tracking, and real-time email notifications.
16+
1317
## Features
1418

1519
### User Management
@@ -64,101 +68,103 @@ A modern web-based task management system built with Django and Tailwind CSS.
6468

6569
## 📸 Screenshots
6670

71+
ℹ️ Note: This project is currently not deployed live due to paid service limitations. However, you can explore its full functionality through the provided screenshots and detailed instructions below.
72+
6773
### 🏠 Home Page
6874

6975
**Light Mode**
7076

71-
![Home Page (Light)](screenshots/light_logout_home.png)
77+
![Home Page (Light) screenshot](screenshots/light_logout_home.png)
7278

7379
**Dark Mode**
7480

75-
![Home Page (Dark)](screenshots/dark_logout_home.png)
81+
![Home Page (Dark) screenshot](screenshots/dark_logout_home.png)
7682

7783
### 🔐 Authentication
7884

7985
**Registration**
8086

81-
![Registration Page](screenshots/register_page.png)
87+
![Registration Page screenshot](screenshots/register_page.png)
8288

8389
### 🚀 Core Features
8490

8591
**Manager Dashboard**
8692

87-
![Manager Dashboard](screenshots/manager_dashboard.png)
93+
![Manager Dashboard screenshot](screenshots/manager_dashboard.png)
8894

8995
**Light Manager Dashboard**
9096

91-
![Light Manager Dashboard](screenshots/light_manager_dashboard.png)
97+
![Light Manager Dashboard screenshot](screenshots/light_manager_dashboard.png)
9298

9399
**Task Status**
94100

95101
- **To-Do**
96102

97-
![To-Do Tasks](screenshots/todo_task.png)
103+
![To-Do Tasks screenshot](screenshots/todo_task.png)
98104

99105
- **In Progress**
100106

101-
![In Progress Tasks](screenshots/inprogress_task.png)
107+
![In Progress Tasks screenshot](screenshots/inprogress_task.png)
102108

103109
- **Completed**
104110

105-
![Completed Tasks](screenshots/completed_task.png)
111+
![Completed Tasks screenshot](screenshots/completed_task.png)
106112

107113
**All Projects**
108114

109-
![All Projects](screenshots/all_projects.png)
115+
![All Projects screenshot](screenshots/all_projects.png)
110116

111117
**Task Form**
112118

113-
![Task Form](screenshots/task_form.png)
119+
![Task Form screenshot](screenshots/task_form.png)
114120

115121
### 👤 User Profile
116122

117123
**User Profile**
118124

119-
![User Profile](screenshots/user_profile.png)
125+
![User Profile screenshot](screenshots/user_profile.png)
120126

121127
**Edit Profile**
122128

123-
![Edit Profile](screenshots/edit_profile.png)
129+
![Edit Profile screenshot](screenshots/edit_profile.png)
124130

125131
**Change Password**
126132

127-
![Change Password](screenshots/cange_password.png)
133+
![Change Password screenshot](screenshots/change_password.png)
128134

129135
### 📄 Additional Pages
130136

131137
**Feature Page**
132138

133-
![Feature Page](screenshots/feature_page.png)
139+
![Feature Page screenshot](screenshots/feature_page.png)
134140

135141
**Pricing Page**
136142

137-
![Pricing Page](screenshots/pricing_page.png)
143+
![Pricing Page screenshot](screenshots/pricing_page.png)
138144

139145
**Contact Page**
140146

141-
![Contact Page](screenshots/contact_page.png)
147+
![Contact Page screenshot](screenshots/contact_page.png)
142148

143149
### 📱 Responsive Design
144150

145151
**Home Page**
146152

147-
![Responsive Home](screenshots/responsive_home.png)
153+
![Responsive Home screenshot](screenshots/responsive_home.png)
148154

149155
**Pricing Page**
150156

151-
![Responsive Pricing](screenshots/responsive_pricing.png)
157+
![Responsive Pricing screenshot](screenshots/responsive_pricing.png)
152158

153159
**Contact Page**
154160

155-
![Responsive Contact](screenshots/responsive_contact.png)
161+
![Responsive Contact screenshot](screenshots/responsive_contact.png)
156162

157163
### ⚙️ Admin Panel
158164

159165
**Django Admin**
160166

161-
![Django Admin](screenshots/dj_admin_panel.png)
167+
![Django Admin screenshot](screenshots/dj_admin_panel.png)
162168

163169
## Setup and Installation
164170

@@ -173,7 +179,7 @@ Follow these steps to set up and run the project locally.
173179
### 1. Clone the repository
174180

175181
```bash
176-
git clone <[repository_url](https://github.com/MrMADS28289/task_management)>
182+
git clone https://github.com/MrMADS28289/task_management.git
177183
cd tasknest
178184
```
179185

@@ -229,7 +235,7 @@ Also, update `ALLOWED_HOSTS` in `tasknest/settings.py` with your production doma
229235
To generate a `SECRET_KEY`, run:
230236

231237
```bash
232-
python generate_secret_key.py
238+
python manage.py get_random_secret_key
233239
```
234240

235241
### 6. Database Setup (PostgreSQL)
@@ -325,9 +331,7 @@ media/
325331
| PUT | /tasks/update/{id}/ | Update task |
326332
| DELETE | /tasks/delete/{id}/ | Delete task |
327333

328-
<!-- SEO -->
329-
<meta name="title" content="Task Management System | Django + Tailwind">
330-
<meta name="description" content="A full-featured task management system built with Django and Tailwind CSS featuring user roles, task/project management, and PostgreSQL.">
334+
> **SEO-Optimized:** Easily indexable by recruiters and search engines via clear descriptions and rich documentation.
331335
332336
## 🧰 Technologies Used
333337

@@ -336,6 +340,21 @@ media/
336340
- **Styling:** Tailwind CSS
337341
- **Environment:** Python-decouple, Ruff, Mypy
338342

343+
## 🧭 Roadmap
344+
345+
- [x] User authentication and profiles
346+
- [x] Project and task CRUD
347+
- [x] Role-based access
348+
- [x] Email notifications
349+
- [ ] Notifications UI
350+
- [ ] REST API for frontend frameworks
351+
- [ ] Real-time updates with Django Channels
352+
353+
## 🐛 Known Issues
354+
355+
- Task deletion does not remove associated media files.
356+
- Email sometimes goes to spam during password reset.
357+
339358
## Contributing
340359

341360
Feel free to fork the repository and contribute. Pull requests are welcome.

0 commit comments

Comments
 (0)