Skip to content

Commit 49dfabf

Browse files
committed
initial readme uploaded, needs formatting fixes
1 parent b55cfa1 commit 49dfabf

1 file changed

Lines changed: 134 additions & 2 deletions

File tree

README.md

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

0 commit comments

Comments
 (0)