Skip to content

Commit eb7f79d

Browse files
Update README.md with additional project details and tech stack information
1 parent c65d0f8 commit eb7f79d

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22

33
Task Master is a feature-rich web application that empowers users to efficiently manage their daily, weekly, and monthly tasks. The application offers a seamless user experience with real-time task management capabilities, allowing users to effortlessly add, edit, delete, and mark tasks as complete without the need to refresh the page.
44

5+
This project is part of the CS50 course: [HarvardX: CS50's Web Programming with Python and JavaScript](https://www.edx.org/learn/web-development/harvard-university-cs50-s-web-programming-with-python-and-javascript).
6+
57
#### Demo: [Youtube](https://youtu.be/zhIjcGUKfak)
8+
69
#### Website: [TaskMaster](https://alif.pythonanywhere.com)
10+
711
#### API Docs: [Docs](https://alif.pythonanywhere.com/api/docs)
12+
813
#### API Playground: [Playground](https://alif.pythonanywhere.com/api/playground)
914

1015
## Features
@@ -23,12 +28,14 @@ Task Master is a feature-rich web application that empowers users to efficiently
2328
## Tech Stack
2429

2530
Front-end:
31+
2632
- HTML: Markup language for creating the structure of web pages.
2733
- CSS: Styling language for designing the appearance of web pages.
2834
- JavaScript: Programming language for adding interactivity to web pages.
2935
- Bootstrap (v5.2.3): Front-end framework for creating responsive and mobile-first web pages.
3036

3137
Back-end:
38+
3239
- Django (v4.2): Python web framework for building the backend of the application.
3340
- Python libraries:
3441
- psycopg2-binary (v2.9.6): PostgreSQL database adapter for Python.
@@ -41,6 +48,7 @@ Back-end:
4148
- drf-yasg (v1.21.7): Yet Another Swagger Generator for Django REST framework.
4249

4350
Front-end Libraries and Plugins (Used in HTML File):
51+
4452
- Font Awesome (latest version): Icon library for adding scalable vector icons.
4553
- Unicons (v2.1.9): Icon library for adding icons to the user interface.
4654
- jQuery (v3.7.0): JavaScript library for simplifying DOM manipulation and event handling.
@@ -140,6 +148,7 @@ DEBUG=True
140148
# Allowed hosts (comma-separated list)
141149
ALLOWED_HOSTS=localhost,127.0.0.1
142150
```
151+
143152
4. Generate a new Django `SECRET_KEY`:
144153

145154
For security reasons, each contributor should generate their own unique `SECRET_KEY`. You can generate a new key by running the following Python code in your terminal:
@@ -173,8 +182,8 @@ python manage.py migrate
173182
```
174183

175184
7. Set up database seeder (optional):
176-
- Change the number of num_tasks_records and num_users_records in `taskmaster/management/command` according to the amount you want
177-
- Run database seeder:
185+
- Change the number of num_tasks_records and num_users_records in `taskmaster/management/command` according to the amount you want
186+
- Run database seeder:
178187

179188
```
180189
python manage.py database_seeder
@@ -253,4 +262,4 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
253262

254263
## Contact
255264

256-
For any inquiries or feedback, please contact me at alifm2101@gmail.com.
265+
For any inquiries or feedback, please contact me at alifm2101@gmail.com.

0 commit comments

Comments
 (0)