roadmap-skill 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +147 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2203 -0
- package/dist/index.js.map +1 -0
- package/dist/web/server.js +441 -0
- package/dist/web/server.js.map +1 -0
- package/package.json +72 -0
- package/templates/ai-project.json +142 -0
- package/templates/mobile-app.json +126 -0
- package/templates/web-app.json +108 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Roadmap Skill Contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
# πΊοΈ Roadmap Skill
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<img src="./imgs/roadmap-skill-web.png" alt="Roadmap Skill Kanban Board" width="900">
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+
<p align="center">
|
|
8
|
+
<strong>Visual project management with drag-and-drop Kanban boards</strong><br>
|
|
9
|
+
Manage tasks through AI assistants or directly in your browser
|
|
10
|
+
</p>
|
|
11
|
+
|
|
12
|
+
<p align="center">
|
|
13
|
+
<a href="https://www.npmjs.com/package/roadmap-skill"><img src="https://img.shields.io/npm/v/roadmap-skill" alt="npm version"></a>
|
|
14
|
+
<a href="https://github.com/shiquda/roadmap-skill/blob/main/LICENSE"><img src="https://img.shields.io/github/license/shiquda/roadmap-skill" alt="License"></a>
|
|
15
|
+
<a href="https://www.npmjs.com/package/roadmap-skill"><img src="https://img.shields.io/npm/dm/roadmap-skill" alt="npm downloads"></a>
|
|
16
|
+
</p>
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## β¨ Why Roadmap Skill?
|
|
21
|
+
|
|
22
|
+
**Tired of juggling multiple project management tools?** Roadmap Skill brings your tasks directly into your AI workflow while offering a beautiful visual interface when you need it.
|
|
23
|
+
|
|
24
|
+
### Three Ways to Work
|
|
25
|
+
|
|
26
|
+
π― **Visual Kanban** β Drag and drop tasks between columns (Todo β In Progress β Review β Done)
|
|
27
|
+
|
|
28
|
+
π€ **AI-Powered** β Ask Claude, Cursor, or any MCP-compatible AI to create, update, and organize tasks
|
|
29
|
+
|
|
30
|
+
β‘ **Instant Start** β One command launches the web interface, no configuration needed
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## π Quick Start
|
|
35
|
+
|
|
36
|
+
### Option 1: Standalone Web App (Easiest)
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npx roadmap-skill-web
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Then open http://localhost:7860 in your browser.
|
|
43
|
+
|
|
44
|
+
### Option 2: Integrate with AI Assistants
|
|
45
|
+
|
|
46
|
+
Add to your AI assistant's MCP configuration:
|
|
47
|
+
|
|
48
|
+
**Claude Desktop:**
|
|
49
|
+
```json
|
|
50
|
+
{
|
|
51
|
+
"mcpServers": {
|
|
52
|
+
"roadmap": {
|
|
53
|
+
"command": "npx",
|
|
54
|
+
"args": ["-y", "roadmap-skill"]
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
**Cursor:**
|
|
61
|
+
```json
|
|
62
|
+
{
|
|
63
|
+
"mcpServers": {
|
|
64
|
+
"roadmap": {
|
|
65
|
+
"command": "npx",
|
|
66
|
+
"args": ["-y", "roadmap-skill"]
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Then ask your AI:
|
|
73
|
+
> "Create a project called 'Website Redesign' with tasks for homepage, about page, and contact form"
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## π‘ What You Can Do
|
|
78
|
+
|
|
79
|
+
### Plan Projects Visually
|
|
80
|
+
- See all your tasks organized in Kanban columns
|
|
81
|
+
- Switch between compact and detailed card views
|
|
82
|
+
- Filter by status, project, or search keywords
|
|
83
|
+
- Drag tasks to update their status instantly
|
|
84
|
+
|
|
85
|
+
### Work with AI
|
|
86
|
+
- "Show me all high priority tasks due this week"
|
|
87
|
+
- "Move the authentication task to in-progress"
|
|
88
|
+
- "Create a new project for mobile app with 5 initial tasks"
|
|
89
|
+
- "What's my overall progress across all projects?"
|
|
90
|
+
|
|
91
|
+
### Collaborate & Track
|
|
92
|
+
- Assign tasks to team members
|
|
93
|
+
- Set due dates and priorities
|
|
94
|
+
- Add tags to organize related work
|
|
95
|
+
- Track completion statistics
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## π¦ Installation
|
|
100
|
+
|
|
101
|
+
### Requirements
|
|
102
|
+
- Node.js 18+ (20+ recommended)
|
|
103
|
+
|
|
104
|
+
### One-Line Install
|
|
105
|
+
```bash
|
|
106
|
+
npm install -g roadmap-skill
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### Or Use Without Installing
|
|
110
|
+
```bash
|
|
111
|
+
npx roadmap-skill-web # Just the web interface
|
|
112
|
+
npx roadmap-skill # Full MCP server
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## π¨ Interface Features
|
|
118
|
+
|
|
119
|
+
| Feature | Description |
|
|
120
|
+
|---------|-------------|
|
|
121
|
+
| **Kanban Board** | Four columns: Todo, In Progress, Review, Done |
|
|
122
|
+
| **Drag & Drop** | Move tasks between columns to update status |
|
|
123
|
+
| **Quick Add** | Click "+" on any column to add tasks instantly |
|
|
124
|
+
| **Dual Views** | Compact mode for overview, Detailed mode for full info |
|
|
125
|
+
| **Smart Search** | Find tasks across all projects instantly |
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## π§ Supported Platforms
|
|
130
|
+
|
|
131
|
+
- β
**Claude Desktop** β Full MCP integration
|
|
132
|
+
- β
**Claude Code** β Command-line AI assistant
|
|
133
|
+
- β
**Cursor** β AI-powered IDE
|
|
134
|
+
- β
**VS Code** β Via Cline or Roo Code extensions
|
|
135
|
+
- β
**Any MCP Client** β Standard MCP protocol support
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## π License
|
|
140
|
+
|
|
141
|
+
MIT Β© [shiquda](https://github.com/shiquda)
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
<p align="center">
|
|
146
|
+
<strong>Star β this repo if you find it helpful!</strong>
|
|
147
|
+
</p>
|
package/dist/index.d.ts
ADDED