Skip to content

Commit ba69a1d

Browse files
committed
Update README.md
1 parent 9533992 commit ba69a1d

File tree

1 file changed

+93
-54
lines changed

1 file changed

+93
-54
lines changed

README.md

Lines changed: 93 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,118 @@
1-
# DayWise - Task Management Application
1+
# DayWise: Your Personal Productivity Companion 🚀
22

3-
DayWise is a web-based task management application built with Flask that helps users organize their daily tasks with time blocks, priorities, and progress tracking.
3+
![DayWise Logo](https://img.shields.io/badge/DayWise-Personal%20Productivity-brightgreen)
44

5-
![DayWise Screenshot](static/dashboard.png)
5+
Welcome to **DayWise**, a personal productivity and time management application designed to help you organize your daily tasks, track your progress, and maximize your efficiency. Built with modern technologies, DayWise provides a seamless user experience across devices.
66

7-
## Live Demo
7+
## Table of Contents
88

9-
The application is live and can be accessed at: [https://zold.pythonanywhere.com](https://zold.pythonanywhere.com)
9+
1. [Features](#features)
10+
2. [Installation](#installation)
11+
3. [Usage](#usage)
12+
4. [Technologies Used](#technologies-used)
13+
5. [Contributing](#contributing)
14+
6. [License](#license)
15+
7. [Contact](#contact)
16+
8. [Releases](#releases)
1017

11-
## Features
18+
## Features 🌟
1219

13-
- **User Authentication**: Secure login and registration system
14-
- **Task Management**: Create, edit, and delete tasks
15-
- **Time Blocks**: Organize tasks by morning, afternoon, evening, or any time
16-
- **Priority Levels**: Set low, medium, or high priorities for tasks
17-
- **Progress Tracking**: Monitor your daily task completion progress
18-
- **Dark Mode**: Toggle between light and dark themes for comfortable viewing
19-
- **Responsive Design**: Works on desktop and mobile devices
20+
- **Task Management**: Create, edit, and delete tasks easily.
21+
- **Progress Tracking**: Monitor your progress with visual indicators.
22+
- **Daily Planner**: Organize your day with a simple interface.
23+
- **Cross-Device Sync**: Access your tasks from any device.
24+
- **Customizable Dashboard**: Tailor your workspace to fit your needs.
25+
- **Time Tracking**: Keep track of how long you spend on each task.
26+
- **Reminders and Notifications**: Never miss a deadline with timely alerts.
2027

21-
## Technologies Used
28+
## Installation 🛠️
2229

23-
- **Backend**: Flask, SQLAlchemy
24-
- **Frontend**: HTML, Tailwind CSS, JavaScript
25-
- **Database**: SQLite
26-
- **Authentication**: Flask-Login
27-
28-
## Installation
30+
To install DayWise, follow these steps:
2931

3032
1. Clone the repository:
33+
```bash
34+
git clone https://github.com/quavo32/daywise.git
35+
```
36+
37+
2. Navigate to the project directory:
38+
```bash
39+
cd daywise
40+
```
41+
42+
3. Install the required dependencies:
43+
```bash
44+
npm install
45+
```
46+
47+
4. Start the application:
48+
```bash
49+
npm start
50+
```
51+
52+
For more detailed installation instructions, please refer to the [Releases](https://github.com/quavo32/daywise/releases) section.
53+
54+
## Usage 📅
55+
56+
Using DayWise is straightforward. Here’s how you can get started:
57+
58+
1. **Create an Account**: Sign up with your email to start using DayWise.
59+
2. **Add Tasks**: Use the "Add Task" button to create new tasks.
60+
3. **Organize Your Day**: Drag and drop tasks to arrange them according to your priorities.
61+
4. **Track Your Time**: Start the timer when you begin a task and stop it when you finish.
62+
5. **Review Progress**: Check your daily progress through the dashboard.
63+
64+
### Example Workflow
65+
66+
1. Open DayWise on your device.
67+
2. Create a new task titled "Finish Project Report".
68+
3. Set a reminder for 3 PM.
69+
4. Start working on the task and track your time.
70+
5. Review your progress at the end of the day.
3171

32-
``` bash
33-
git clone https://github.com/AhmedOsamaMath/daywise.git
34-
cd daywise
35-
```
72+
## Technologies Used 🛠️
3673

37-
2. Install the required packages:
74+
DayWise is built using a combination of modern technologies:
3875

39-
``` bash
40-
pip install -r requirements.txt
41-
```
76+
- **Frontend**: React.js for a responsive user interface.
77+
- **Backend**: Node.js and Express for server-side logic.
78+
- **Database**: MongoDB for storing user data and tasks.
79+
- **Authentication**: JSON Web Tokens (JWT) for secure user authentication.
80+
- **Styling**: CSS and Bootstrap for a clean design.
4281

43-
## Usage
82+
## Contributing 🤝
4483

45-
1. Start the application:
84+
We welcome contributions to DayWise! If you want to help improve the application, please follow these steps:
4685

47-
``` bash
48-
flask run
49-
```
86+
1. Fork the repository.
87+
2. Create a new branch:
88+
```bash
89+
git checkout -b feature/YourFeatureName
90+
```
91+
3. Make your changes and commit them:
92+
```bash
93+
git commit -m "Add your feature"
94+
```
95+
4. Push to your fork:
96+
```bash
97+
git push origin feature/YourFeatureName
98+
```
99+
5. Open a pull request.
50100

51-
2. Open your browser and navigate to `http://127.0.0.1:5000/`
101+
## License 📜
52102

53-
3. Register a new account or log in with existing credentials
103+
DayWise is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
54104

55-
4. Start managing your tasks!
105+
## Contact 📧
56106

57-
## Project Structure
107+
For any inquiries or feedback, feel free to reach out:
58108

59-
```
60-
daywise/
61-
├── app.py # Main application file
62-
├── templates/ # HTML templates
63-
│ ├── base.html # Base template with common elements
64-
│ ├── dashboard.html # Main dashboard view
65-
│ ├── index.html # Landing page
66-
│ ├── login.html # Login page
67-
│ └── register.html # Registration page
68-
├── static/ # Static files (if any)
69-
├── instance/ # Contains the SQLite database
70-
└── requirements.txt # Project dependencies
71-
```
109+
- **Email**: support@daywiseapp.com
110+
- **Twitter**: [@DayWiseApp](https://twitter.com/DayWiseApp)
72111

73-
## Contributing
112+
## Releases 📦
74113

75-
Contributions are welcome! Please feel free to submit a Pull Request.
114+
To download the latest version of DayWise, visit the [Releases](https://github.com/quavo32/daywise/releases) section. Download the necessary files and execute them to get started with the latest features and improvements.
76115

77-
## License
116+
---
78117

79-
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.
118+
Thank you for checking out DayWise! We hope this application helps you manage your time and tasks more effectively. Enjoy your journey to increased productivity!

0 commit comments

Comments
 (0)