Skip to content

Commit 4627c95

Browse files
committedSep 21, 2024·
Updated README
1 parent a65f5f5 commit 4627c95

File tree

2 files changed

+50
-25
lines changed

2 files changed

+50
-25
lines changed
 

‎README.md

+50-25
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,54 @@
11
# TaskFlow
22

3-
## Built an Task Management Dashboard with the Kanban Board
3+
![TaskFlow Management](./src/assets/flow2.png)
44

5-
### Objective
5+
### Introduction
66

7-
To build a task management dashboard in **Next.js** that includes two screens: a task list and a Kanban board. The app enables users to manage tasks through a list view and a Kanban board, where tasks can be moved between statuses. It includes user authentication, a backend API, and a MongoDB database. The UI is visually appealing and implemented using **Shadcn UI**. The app is deployed on **Vercel** for review.
7+
To build a task management dashboard in **Next.js** named TaskFlow that includes two screens: a task list and a Kanban board. The app enables users to manage tasks through a list view and a Kanban board, where tasks can be moved between statuses (To-Do, In-Progress and Complete) using **Drag and Drop** functionality. It includes user authentication, a backend built on Node.js, and a MongoDB database. The UI is visually appealing and implemented using **Shadcn UI** and **Accertinity UI**.
8+
9+
![Taskflow Task](./src//assets/Animation%20-%201726842395741.gif)
10+
11+
### Project Showcase
12+
13+
https://github.com/user-attachments/assets/ac3a9585-3ed4-4e31-a00e-d14a0970e4c0
814

915
### Tech Stack
1016

1117
- **Frontend:**
1218

13-
- Next.js ![Next.js](https://nextjs.org/static/favicon/favicon.ico)
14-
- React ![React](https://reactjs.org/logo-og.png)
15-
- Shadcn UI ![Shadcn UI](https://shadcn.com/favicon.ico)
19+
- Next.js
20+
- React.js
21+
- TypeScript
22+
- State Management using Redux
23+
- Input Validation using Zod
24+
- Shadcn UI
25+
- Accertinity UI
26+
- Tailwind CSS
1627

1728
- **Backend:**
1829

19-
- Node.js ![Node.js](https://nodejs.org/static/images/logo.svg)
20-
- Express ![Express](https://expressjs.com/images/express-facebook-share.png)
21-
- MongoDB ![MongoDB](https://www.mongodb.com/assets/images/global/leaf.png)
30+
- Node.js
31+
- Express
32+
- MongoDB
33+
- Input Validation using Zod
2234

2335
- **Deployment:**
24-
- Vercel ![Vercel](https://vercel.com/favicon.ico)
36+
37+
- Vercel
38+
39+
- **Version Control**
40+
- Git
41+
- Github
2542

2643
### Features and Requirements
2744

2845
1. **User Authentication:**
2946

30-
- Implement user authentication (sign up, log in, and logout) using JWT (JSON Web Tokens) and Next-Auth.
47+
- Implement user authentication (sign up, log in, and logout) using **JWT** (JSON Web Tokens) and **Next-Auth**.
3148
- Protect routes to ensure that only authenticated users can access the task management features.
3249

3350
2. **Task Management:**
51+
![Manage Tasks Efficiently](./src//assets/manage_task.webp)
3452

3553
- Users can create, edit, delete, and view tasks.
3654
- Each task has the following fields:
@@ -41,29 +59,34 @@ To build a task management dashboard in **Next.js** that includes two screens: a
4159
- Due Date (date, optional)
4260
- Tasks should be filterable and sortable by status, priority, and due date.
4361

62+
![Task Complete](./src/assets/task_complete.webp)
63+
4464
3. **Two Screens:**
4565

4666
- **Task List Screen:**
4767
- Display a list of tasks with filtering and sorting options.
48-
- Allow users to perform CRUD operations directly from the list view.
68+
- Allow users to perform **CRUD** operations directly from the list view.
69+
70+
![Kanban Board ](./src/assets/kanaban.png)
71+
4972
- **Kanban Board Screen:**
5073
- Implement drag-and-drop feature for easily handling the tasks.
5174
- Display tasks in a Kanban board format with columns for each status.
52-
- Enable drag-and-drop functionality for moving tasks between statuses.
75+
- Enable **drag-and-drop** functionality for moving tasks between statuses.
5376
- Update the task status dynamically when moved between columns.
5477

5578
4. **Backend API:**
5679

57-
- Build a backend API using Node.js and Express to handle CRUD operations for tasks and user authentication.
58-
- Connect to a MongoDB database to store user and task data.
80+
- Build a backend API using **Node.js** and Express to handle CRUD operations for tasks and user authentication.
81+
- Connect to a **MongoDB** database to store user and task data.
5982

6083
5. **Frontend Features:**
6184

62-
- Use Next.js to create a responsive and dynamic user interface.
85+
- Use **Next.js** to create a responsive and dynamic user interface.
6386
- Implement a task list view and a Kanban board view.
64-
- Use state management (React context or a library like Redux) to manage the application state.
87+
- Use state management **Redux** to manage the application state.
6588
- Provide a form for creating and editing tasks.
66-
- Display error messages and handle form validation using Zod.
89+
- Display error messages and handle form validation using **Zod**.
6790

6891
6. **UI Design:**
6992

@@ -74,19 +97,21 @@ To build a task management dashboard in **Next.js** that includes two screens: a
7497
7. **Deployment:**
7598

7699
- Deploy the app on Vercel and ensure that it is fully functional.
100+
![TaskFlow Website](https://ayushw0w-taskflow.vercel.app)
77101
- Test credentials:
78-
- Username: user@example.com
79-
- Password: password123
102+
- Username: zorojoro@gmail.com
103+
- Password: 12345678
104+
- Please check out my website and share your feedback!
80105

81106
8. **Code Quality:**
82107

83-
- Follow best practices for React and MERN stack development.
108+
- Followed best practices for React and MERN stack development.
84109
- Write clean, maintainable, and modular code.
85-
- Include comments to explain complex logic.
86-
- Use TypeScript to define types for better maintainability (optional but recommended).
110+
- Included comments to explain complex logic.
111+
- Used **TypeScript** to define types for better maintainability.
87112

88113
9. **Additional Considerations:**
89-
- Use a version control system (like Git) and provide a link to the repository.
90-
- Implement at least one custom hook in React to manage some part of the application logic.
114+
- Used a Git version control system.
115+
<!-- - Implement at least one custom hook in React to manage some part of the application logic. -->
91116

92117
---
66.8 KB
Loading

0 commit comments

Comments
 (0)
Please sign in to comment.