Skip to content
This repository was archived by the owner on Mar 21, 2026. It is now read-only.

Commit fb11415

Browse files
committed
updates readme
1 parent ef32ce1 commit fb11415

3 files changed

Lines changed: 18 additions & 25 deletions

File tree

README.md

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Task Pro
22

3-
Task Pro is an intuitive web application crafted to streamline project and task management.
3+
Task Pro is an intuitive web application crafted to streamline project and task management.
44

5-
It empowers users of all proficiency levels to enhance their time management and organizational abilities with its user-friendly interface.
5+
It empowers users of all proficiency levels to enhance their time management and organizational abilities with its user-friendly interface.
66

77
Whether you opt for private usage or collaboration, Task Pro offers a comprehensive solution for creating, organizing, and sharing projects seamlessly.
88

@@ -11,47 +11,45 @@ Whether you opt for private usage or collaboration, Task Pro offers a comprehens
1111
![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) ![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E) ![React Router](https://img.shields.io/badge/React_Router-CA4245?style=for-the-badge&logo=react-router&logoColor=white) ![SASS](https://img.shields.io/badge/SASS-hotpink.svg?style=for-the-badge&logo=SASS&logoColor=white) ![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white) ![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white) ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white) ![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB)
1212

1313
## Project Frames
14-
![Project Frame](src/assets/projectFrame.png)
15-
1614

15+
![Project Frame](src/assets/projectFrame.png)
1716

1817
## Features
1918

2019
### User Sign-Up and Login
20+
2121
- Easily create a user profile to personalize user experience.
2222
- Secure authentication ensures your private boards are only accessible to you.
2323

24-
2524
![Authentication](src/assets/authPage.png)
2625

27-
28-
2926
### Board Management
30-
- Create new board with ease.
31-
- Organize your task for different stage for efficiently managing a project.
3227

28+
- Create, edit and delete boards with ease.
29+
- Instantly swap between boards to display their corresponding tasks.
30+
- All changes to boards and tasks are maintained on the frontend and backend.
3331

3432
![Dashboard](src/assets/Dashboard.png)
3533

34+
### Task Management
3635

37-
![taskCreation](src/assets/taskCreation.png)
38-
39-
36+
- Create any number of new task cards with name, notes and status.
37+
- Edit and delete task cards as needed.
38+
- Move cards from one status column to another.
4039

40+
![taskCreation](src/assets/taskCreation.png)
4141

42-
## Front End
42+
## Front End
4343

4444
- Developed using **React** for a responsive and dynamic user interface.
4545
- Utilizes **React Router** for smooth navigation between pages.
4646
- Stylish and customizable design with **SASS** for a modern look and organized styling.
4747

48-
4948
## Back End
5049

5150
- Powered by **Node.js** and **Express** for robust server-side functionality.
5251
- Data storage and retrieval are handled by **MongoDB**, ensuring data persistence and flexibility.
5352

54-
5553
## Stretch Features
5654

5755
In the future, we plan to introduce the following features:
@@ -63,25 +61,20 @@ In the future, we plan to introduce the following features:
6361
- Light and Dark mode.
6462
- OTP/Email 2 step authentication.
6563

66-
67-
68-
6964
## To Launch the Application
7065

71-
**Step 1**. Clone repo to code editor
66+
**Step 1**. Clone repo to code editor
7267

73-
**Step 2**. Run npm install to install all dependencies
68+
**Step 2**. Run npm install to install all dependencies
7469

75-
**Step 3**. Make sure node version is 18.17.1 or older, can use nvm to install the needed version.
70+
**Step 3**. Make sure node version is 18.17.1 or older, can use nvm to install the needed version.
7671

77-
**Step 4**. Create env file and make sure to have ```PORT = 3000``` and ```MONGO_URI = (Mongodb connection URI)```
78-
79-
**Step 5**. start the project with ```npm start``` or ```npm run dev``` (for dev mode)
72+
**Step 4**. Create env file and make sure to have `PORT = 3000` and `MONGO_URI = (Mongodb connection URI)`
8073

74+
**Step 5**. start the project with `npm start` or `npm run dev` (for dev mode)
8175

8276
## Authors
8377

8478
- Nam Ha: [Github](https://github.com/namos2502)
8579

8680
- John Costello: [Github](https://github.com/johnlcos)
87-

src/assets/Dashboard.png

-187 KB
Loading

src/assets/taskCreation.png

-100 KB
Loading

0 commit comments

Comments
 (0)