Skip to content

Commit 8078066

Browse files
committed
finished readme & formatting
1 parent 49dfabf commit 8078066

1 file changed

Lines changed: 87 additions & 78 deletions

File tree

README.md

Lines changed: 87 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,134 +1,143 @@
1-
Task Manager Application
1+
# Task Manager Application
22

33
A web application that allows users to create and manage personal tasks through a simple interface.
44

5+
## Screenshots
56

6-
Technologies Used
77

8-
Python
9-
Flask
10-
Flask-Login
11-
Tailwind CSS
12-
SQLite
13-
SQLAlchemy
14-
Jinja2
8+
| Login | Tasks |
9+
|-----------------------------------|------------------------------------|
10+
|![login.png](screenshots/login.png)|![tasks.png](screenshots/tasks.png)|
1511

12+
| Search | Create |
13+
|---------------------------------------|--------------------------------------|
14+
|![search.png](screenshots/search.png)|![create.png](screenshots/create.png)|
1615

17-
Features
18-
19-
User Authentication
16+
| Account | Index |
17+
|---------|-------|
18+
|![account.png](screenshots/account.png)|![index.png](screenshots/index.png)|
2019

21-
Register user
22-
Login/Logout
23-
Update password
24-
Delete account
2520

26-
Task Management
21+
## Technologies Used
2722

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
3230

33-
Application Features
3431

35-
Search function
36-
Pagination
37-
Responsive design
3832

33+
## Features
34+
35+
### User Authentication
3936

40-
Installation
37+
* Register user
38+
* Login/Logout
39+
* Update password
40+
* Delete account
4141

42-
1. Clone the repository
42+
### Task Management
4343

44-
git clone https://github.com/mpbe/TaskManager.git
44+
* Create tasks
45+
* Update tasks
46+
* Complete tasks
47+
* Delete tasks
4548

49+
### Application Features
4650

47-
2. Navigate to project folder
51+
* Search function
52+
* Pagination
53+
* Responsive design
4854

49-
cd TaskManager
5055

5156

52-
3. Create virtual environment
57+
## Installation
5358

54-
python -m venv venv
59+
### Clone the repository
5560

61+
`git clone https://github.com/mpbe/TaskManager.git`
5662

57-
4. Activate virtual environment
5863

59-
Windows: venv\Scripts\activate
60-
Mac/Linux: source venv/bin/activate
64+
### Navigate to project folder
6165

66+
`cd TaskManager`
6267

63-
5. Install dependencies
6468

65-
pip install -r requirements.txt
69+
### Create virtual environment
6670

71+
`python -m venv venv`
6772

68-
6. Run the application
6973

70-
python app.py
74+
### Activate virtual environment
7175

76+
Windows:
7277

73-
7. Open in browser
78+
`venv\Scripts\activate`
7479

75-
http://127.0.0.1:5000
80+
Mac/Linux:
7681

82+
`source venv/bin/activate`
7783

78-
Usage
7984

80-
You can either create your own account or seed the database with test data.
85+
### Install dependencies
8186

82-
Seed the database:
83-
python seed.py
87+
`pip install -r requirements.txt`
8488

85-
Main test user:
86-
username: aaaa
87-
password: test
8889

89-
If a user is registered they will be automatically logged in.
90+
### Run the application
9091

91-
Tasks can be viewed individually by clicking the More Details button
92+
`python app.py`
9293

9394

94-
Project Structure
95+
### Open in browser
96+
97+
http://127.0.0.1:5000
9598

96-
app/
97-
|--- forms/
98-
|--- models/
99-
|--- routes/
100-
|--- schemas/
101-
|--- services/
102-
|--- templates/
103-
|--- partials/
104-
|--- utils/
10599

106-
tests/
107100

101+
## Usage
108102

109-
Future Improvements
103+
You can either create your own account or seed the database with test data.
110104

111-
Task categories
112-
Task sorting
113-
Account verification
114-
Rest API support
105+
### Seed the database:
115106

116-
107+
`python seed.py`
108+
109+
### Main test user:
117110

111+
* **username**: *aaaa*
112+
* **password**: *test*
113+
114+
If a user is registered they will be automatically logged in.
118115

119-
example dashboard page
116+
Tasks can be viewed individually by clicking the *More Details* button
120117

121-
Welcome to TaskManager
122118

123-
This application allows users to create and manage personal tasks.
124119

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+
130137

138+
## Future Improvements
131139

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

Comments
 (0)