|
1 | | -Task Manager Application |
| 1 | +# Task Manager Application |
2 | 2 |
|
3 | 3 | A web application that allows users to create and manage personal tasks through a simple interface. |
4 | 4 |
|
| 5 | +## Screenshots |
5 | 6 |
|
6 | | -Technologies Used |
7 | 7 |
|
8 | | -Python |
9 | | -Flask |
10 | | -Flask-Login |
11 | | -Tailwind CSS |
12 | | -SQLite |
13 | | -SQLAlchemy |
14 | | -Jinja2 |
| 8 | +| Login | Tasks | |
| 9 | +|-----------------------------------|------------------------------------| |
| 10 | +||| |
15 | 11 |
|
| 12 | +| Search | Create | |
| 13 | +|---------------------------------------|--------------------------------------| |
| 14 | +||| |
16 | 15 |
|
17 | | -Features |
18 | | - |
19 | | -User Authentication |
| 16 | +| Account | Index | |
| 17 | +|---------|-------| |
| 18 | +||| |
20 | 19 |
|
21 | | -Register user |
22 | | -Login/Logout |
23 | | -Update password |
24 | | -Delete account |
25 | 20 |
|
26 | | -Task Management |
| 21 | +## Technologies Used |
27 | 22 |
|
28 | | -Create tasks |
29 | | -Update tasks |
30 | | -Complete tasks |
31 | | -Delete tasks |
| 23 | +* Python |
| 24 | +* Flask |
| 25 | +* Flask-Login |
| 26 | +* Tailwind CSS |
| 27 | +* SQLite |
| 28 | +* SQLAlchemy |
| 29 | +* Jinja2 |
32 | 30 |
|
33 | | -Application Features |
34 | 31 |
|
35 | | -Search function |
36 | | -Pagination |
37 | | -Responsive design |
38 | 32 |
|
| 33 | +## Features |
| 34 | + |
| 35 | +### User Authentication |
39 | 36 |
|
40 | | -Installation |
| 37 | +* Register user |
| 38 | +* Login/Logout |
| 39 | +* Update password |
| 40 | +* Delete account |
41 | 41 |
|
42 | | -1. Clone the repository |
| 42 | +### Task Management |
43 | 43 |
|
44 | | -git clone https://github.com/mpbe/TaskManager.git |
| 44 | +* Create tasks |
| 45 | +* Update tasks |
| 46 | +* Complete tasks |
| 47 | +* Delete tasks |
45 | 48 |
|
| 49 | +### Application Features |
46 | 50 |
|
47 | | -2. Navigate to project folder |
| 51 | +* Search function |
| 52 | +* Pagination |
| 53 | +* Responsive design |
48 | 54 |
|
49 | | -cd TaskManager |
50 | 55 |
|
51 | 56 |
|
52 | | -3. Create virtual environment |
| 57 | +## Installation |
53 | 58 |
|
54 | | -python -m venv venv |
| 59 | +### Clone the repository |
55 | 60 |
|
| 61 | +`git clone https://github.com/mpbe/TaskManager.git` |
56 | 62 |
|
57 | | -4. Activate virtual environment |
58 | 63 |
|
59 | | -Windows: venv\Scripts\activate |
60 | | -Mac/Linux: source venv/bin/activate |
| 64 | +### Navigate to project folder |
61 | 65 |
|
| 66 | +`cd TaskManager` |
62 | 67 |
|
63 | | -5. Install dependencies |
64 | 68 |
|
65 | | -pip install -r requirements.txt |
| 69 | +### Create virtual environment |
66 | 70 |
|
| 71 | +`python -m venv venv` |
67 | 72 |
|
68 | | -6. Run the application |
69 | 73 |
|
70 | | -python app.py |
| 74 | +### Activate virtual environment |
71 | 75 |
|
| 76 | +Windows: |
72 | 77 |
|
73 | | -7. Open in browser |
| 78 | +`venv\Scripts\activate` |
74 | 79 |
|
75 | | -http://127.0.0.1:5000 |
| 80 | +Mac/Linux: |
76 | 81 |
|
| 82 | +`source venv/bin/activate` |
77 | 83 |
|
78 | | -Usage |
79 | 84 |
|
80 | | -You can either create your own account or seed the database with test data. |
| 85 | +### Install dependencies |
81 | 86 |
|
82 | | -Seed the database: |
83 | | -python seed.py |
| 87 | +`pip install -r requirements.txt` |
84 | 88 |
|
85 | | -Main test user: |
86 | | -username: aaaa |
87 | | -password: test |
88 | 89 |
|
89 | | -If a user is registered they will be automatically logged in. |
| 90 | +### Run the application |
90 | 91 |
|
91 | | -Tasks can be viewed individually by clicking the More Details button |
| 92 | +`python app.py` |
92 | 93 |
|
93 | 94 |
|
94 | | -Project Structure |
| 95 | +### Open in browser |
| 96 | + |
| 97 | +http://127.0.0.1:5000 |
95 | 98 |
|
96 | | -app/ |
97 | | - |--- forms/ |
98 | | - |--- models/ |
99 | | - |--- routes/ |
100 | | - |--- schemas/ |
101 | | - |--- services/ |
102 | | - |--- templates/ |
103 | | - |--- partials/ |
104 | | - |--- utils/ |
105 | 99 |
|
106 | | -tests/ |
107 | 100 |
|
| 101 | +## Usage |
108 | 102 |
|
109 | | -Future Improvements |
| 103 | +You can either create your own account or seed the database with test data. |
110 | 104 |
|
111 | | -Task categories |
112 | | -Task sorting |
113 | | -Account verification |
114 | | -Rest API support |
| 105 | +### Seed the database: |
115 | 106 |
|
116 | | - |
| 107 | +`python seed.py` |
| 108 | + |
| 109 | +### Main test user: |
117 | 110 |
|
| 111 | +* **username**: *aaaa* |
| 112 | +* **password**: *test* |
| 113 | + |
| 114 | +If a user is registered they will be automatically logged in. |
118 | 115 |
|
119 | | -example dashboard page |
| 116 | +Tasks can be viewed individually by clicking the *More Details* button |
120 | 117 |
|
121 | | -Welcome to TaskManager |
122 | 118 |
|
123 | | -This application allows users to create and manage personal tasks. |
124 | 119 |
|
125 | | -Features include: |
126 | | -• task creation |
127 | | -• task completion tracking |
128 | | -• search and pagination |
129 | | -• secure user accounts |
| 120 | +## Project Structure |
| 121 | + |
| 122 | +``` |
| 123 | +app/ |
| 124 | +├── forms/ |
| 125 | +├── models/ |
| 126 | +├── routes/ |
| 127 | +├── schemas/ |
| 128 | +├── services/ |
| 129 | +├── templates/ |
| 130 | +│ └── partials/ |
| 131 | +└── utils/ |
| 132 | +
|
| 133 | +screenshots/ |
| 134 | +tests/ |
| 135 | +``` |
| 136 | + |
130 | 137 |
|
| 138 | +## Future Improvements |
131 | 139 |
|
132 | | -task creation, update and delete |
133 | | -search functionality and pagination |
134 | | -secure user accounts |
| 140 | +* Task categories |
| 141 | +* Task sorting |
| 142 | +* Account verification |
| 143 | +* Rest API support |
0 commit comments