Bhaskar2611 commited on
Commit
2324e63
Β·
verified Β·
1 Parent(s): 3a8aada

Delete README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -131
README.md DELETED
@@ -1,131 +0,0 @@
1
- # Smart Task Planner
2
-
3
- Break any goal into a realistic, timeline-respecting action plan β€” in seconds.
4
-
5
- ## About
6
-
7
- Enter a goal and a timeframe. The planner returns a clean, day-by-day task list that finishes exactly on the deadline β€” no overruns, no fluff.
8
-
9
- Here's the thing: this tool turns vague deadlines into concrete, prioritized work you can act on immediately.
10
-
11
- ---
12
-
13
- ## Live demo
14
-
15
- Try it yourself:
16
-
17
- [![Open in Spaces](https://img.shields.io/badge/πŸ€—-Open%20in%20Spaces-blue)](https://huggingface.co/spaces/your-username/smart-task-planner)
18
-
19
- Replace `your-username` with your Hugging Face username after you deploy.
20
-
21
- ---
22
-
23
- ## How it works
24
-
25
- 1. You give a goal with a timeframe, for example: `Build a website in 10 days`.
26
- 2. The planner:
27
-
28
- * Detects the total number of days (for example 3 weeks -> 21 days).
29
- * Produces 8–15 realistic tasks covering planning, execution, and launch.
30
- * Enforces the final deadline strictly β€” no task goes past Day N.
31
- 3. You get a numbered plan with due dates (`Due: Day N`), dependencies (`Depends on: Task 3`), and short descriptions.
32
-
33
- ---
34
-
35
- ## Tech stack
36
-
37
- | Component | Technology | Why we chose it |
38
- | ------------- | -----------------------------: | --------------------------------------------------------------- |
39
- | Core AI model | Qwen/Qwen2.5-Coder-7B-Instruct | Strong instruction-following and reliable structured output |
40
- | Backend | Python + `huggingface_hub` | Official client for secure, simple LLM calls |
41
- | Frontend | Gradio | Fast UI with minimal code, great for demos |
42
- | Hosting | Hugging Face Spaces | One-click deploy, secrets management |
43
- | Prompting | Constraint-aware instructions | Ensures timeline compliance without over-constraining the model |
44
-
45
- ---
46
-
47
- ## Project structure
48
-
49
- ```
50
- smart-task-planner/
51
- β”œβ”€β”€ app.py # Gradio UI and user interaction
52
- β”œβ”€β”€ planner.py # LLM task generation with timeline enforcement
53
- β”œβ”€β”€ requirements.txt # Dependencies
54
- └── README.md # This file
55
- ```
56
-
57
- ---
58
-
59
- ## Key features
60
-
61
- * Timeline-aware: converts "2 weeks" β†’ 14 days, "3 weeks" β†’ 21 days.
62
- * Strict deadline enforcement: tasks never exceed your limit.
63
- * Realistic workflows: supports parallel tracks like marketing during development.
64
- * Zero fluff output: a clean, numbered task list only.
65
- * Lightweight and fast: no DB, no heavy infra.
66
-
67
- ---
68
-
69
- ## Example input β†’ output
70
-
71
- **Input**: `Launch a mobile app in 2 weeks`
72
-
73
- **Output**:
74
-
75
- ```
76
- 1. Define app features and user stories - Due: Day 2 - Depends on: None
77
- Description: Finalize core functionality and target audience.
78
-
79
- 2. Design UI wireframes - Due: Day 5 - Depends on: Task 1
80
- Description: Sketch key screens and navigation flow.
81
-
82
- 3. Set up development environment - Due: Day 3 - Depends on: None
83
- Description: Configure tools, repo, and cloud services.
84
-
85
- 4. Build backend API - Due: Day 8 - Depends on: Task 3
86
- Description: Implement user auth, data storage, and core logic.
87
-
88
- 5. Develop frontend - Due: Day 11 - Depends on: Tasks 2 and 4
89
- Description: Code responsive mobile interface.
90
-
91
- 6. Test full application - Due: Day 13 - Depends on: Task 5
92
- Description: Run QA on real devices and fix critical bugs.
93
-
94
- 7. Launch on app stores - Due: Day 14 - Depends on: Task 6
95
- Description: Submit to Apple App Store and Google Play.
96
- ```
97
-
98
- ---
99
-
100
- ## Deploy your own
101
-
102
- 1. Create a Hugging Face account.
103
- 2. Go to Hugging Face Spaces β†’ Create new Space
104
-
105
- * SDK: Gradio
106
- * Hardware: CPU (inference can run via HF Inference API)
107
- 3. Add your HF token as a secret:
108
-
109
- * Key: `HF_TOKEN`
110
- * Value: your HF token with Inference API role
111
- 4. Push the repo to your Space and deploy.
112
-
113
- ---
114
-
115
- ## Why this matters
116
-
117
- Most AI planners either ignore deadlines or generate unrealistic plans. This tool keeps the timeline real and enforces the end date strictly. If Day 21 is your deadline, Day 22 does not exist.
118
-
119
- Built for founders, PMs, students, and anyone who needs to ship on time.
120
-
121
- ---
122
-
123
- ## License
124
-
125
- MIT License β€” use, modify, and share freely.
126
-
127
- ---
128
-
129
- Made with ❀️ and Qwen2.5-Coder on Hugging Face
130
-
131
- No data stored. No tracking. Just smart planning.