step-overflow 0.1.0 → 0.1.1
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/README.ja.md +41 -14
- package/README.md +44 -3
- package/dist/lib/git.js +4 -4
- package/package.json +1 -1
package/README.ja.md
CHANGED
|
@@ -1,33 +1,60 @@
|
|
|
1
|
-
|
|
1
|
+
<h1 align="center">🚶step-overflow</h1>
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<p align="center">
|
|
4
|
+
<strong>デスクワーク中のウォーキングを、もっと楽しく続けるためのCLIツール。</strong>
|
|
5
|
+
</p>
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
<p align="center">
|
|
8
|
+
仕事をしながら歩いた時間や距離を手軽に記録し、進捗はGitHubへ自動で反映。<br />
|
|
9
|
+
バーチャルなルートの踏破や実績解除を楽しみながら、健康づくりと日々の継続を後押しします。
|
|
10
|
+
</p>
|
|
6
11
|
|
|
7
|
-
|
|
12
|
+
<p align="center">
|
|
13
|
+
<a href="./README.md">English</a> ·
|
|
14
|
+
<a href="./README.ja.md">日本語</a>
|
|
15
|
+
</p>
|
|
8
16
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
17
|
+
<p align="center">
|
|
18
|
+
<img src="https://img.shields.io/badge/CLI-fast%20logging-blue" />
|
|
19
|
+
<img src="https://img.shields.io/badge/GitHub-auto--push-black" />
|
|
20
|
+
<img src="https://img.shields.io/badge/Journey-virtual%20routes-green" />
|
|
21
|
+
<img src="https://img.shields.io/badge/Achievements-49%20unlockables-orange" />
|
|
22
|
+
</p>
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## step-overflowでできること
|
|
12
27
|
|
|
13
|
-
|
|
28
|
+
- **かんたん記録** — ターミナルからすぐにウォーキングを記録
|
|
29
|
+
- **GitHub連携** — 進捗を自動でコミット＆プッシュ
|
|
30
|
+
- **ルート踏破** — 毎日のウォーキングを旅の進捗として楽しめる
|
|
31
|
+
- **実績解除** — 達成状況が見えるから続けやすい
|
|
14
32
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
33
|
+
## プレビュー
|
|
34
|
+
|
|
35
|
+
<p align="center">
|
|
36
|
+
<img width="976" alt="Dashboard overview" src="https://github.com/user-attachments/assets/d9f5ea55-2313-41dd-9dd8-64413587feb8" />
|
|
37
|
+
</p>
|
|
38
|
+
|
|
39
|
+
<p align="center">
|
|
40
|
+
<img width="983" alt="Journey view" src="https://github.com/user-attachments/assets/e153b8a2-91b0-4d7d-ae51-440b869bdd53" />
|
|
41
|
+
</p>
|
|
42
|
+
|
|
43
|
+
<p align="center">
|
|
44
|
+
<img width="953" alt="Achievements view" src="https://github.com/user-attachments/assets/02fa44be-61d4-4a71-9012-a0ab0711999c" />
|
|
45
|
+
</p>
|
|
18
46
|
|
|
19
47
|
## クイックスタート
|
|
20
48
|
|
|
21
49
|
```bash
|
|
22
|
-
# 初期設定（GitHub
|
|
50
|
+
# 初期設定（GitHubリポジトリ作成、ローカル設定、ルート選択）
|
|
23
51
|
stp init
|
|
24
52
|
|
|
25
|
-
# 60
|
|
53
|
+
# 60分歩いた記録を追加
|
|
26
54
|
stp add 60
|
|
27
55
|
|
|
28
56
|
# ダッシュボードをブラウザで開く
|
|
29
57
|
stp open
|
|
30
|
-
```
|
|
31
58
|
|
|
32
59
|
## コマンド
|
|
33
60
|
|
package/README.md
CHANGED
|
@@ -1,8 +1,49 @@
|
|
|
1
|
-
|
|
1
|
+
<h1 align="center">🚶step-overflow</h1>
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<p align="center">
|
|
4
|
+
<strong>A high-energy CLI for treadmill desk walkers.</strong>
|
|
5
|
+
</p>
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
<p align="center">
|
|
8
|
+
Track your steps at work, log progress instantly, auto-push to GitHub,<br />
|
|
9
|
+
and stay motivated with virtual journeys and unlockable achievements - <br />
|
|
10
|
+
all while building healthier habits without slowing down.
|
|
11
|
+
</p>
|
|
12
|
+
|
|
13
|
+
<p align="center">
|
|
14
|
+
<a href="./README.md">English</a> ·
|
|
15
|
+
<a href="./README.ja.md">日本語</a>
|
|
16
|
+
</p>
|
|
17
|
+
|
|
18
|
+
<p align="center">
|
|
19
|
+
<img src="https://img.shields.io/badge/CLI-fast%20logging-blue" />
|
|
20
|
+
<img src="https://img.shields.io/badge/GitHub-auto--push-black" />
|
|
21
|
+
<img src="https://img.shields.io/badge/Journey-gameful-green" />
|
|
22
|
+
<img src="https://img.shields.io/badge/Achievements-49%20unlockables-orange" />
|
|
23
|
+
</p>
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Why step-overflow?
|
|
28
|
+
|
|
29
|
+
- **Fast logging** — record a walk in seconds from the terminal
|
|
30
|
+
- **GitHub sync** — automatically commit and push your progress
|
|
31
|
+
- **Journey mode** — turn daily walking into a virtual adventure
|
|
32
|
+
- **Achievements** — unlock milestones and keep momentum going
|
|
33
|
+
|
|
34
|
+
## Preview
|
|
35
|
+
|
|
36
|
+
<p align="center">
|
|
37
|
+
<img width="976" alt="Dashboard overview" src="https://github.com/user-attachments/assets/d9f5ea55-2313-41dd-9dd8-64413587feb8" />
|
|
38
|
+
</p>
|
|
39
|
+
|
|
40
|
+
<p align="center">
|
|
41
|
+
<img width="983" alt="Journey view" src="https://github.com/user-attachments/assets/e153b8a2-91b0-4d7d-ae51-440b869bdd53" />
|
|
42
|
+
</p>
|
|
43
|
+
|
|
44
|
+
<p align="center">
|
|
45
|
+
<img width="953" alt="Achievements view" src="https://github.com/user-attachments/assets/02fa44be-61d4-4a71-9012-a0ab0711999c" />
|
|
46
|
+
</p>
|
|
6
47
|
|
|
7
48
|
## Install
|
|
8
49
|
|
package/dist/lib/git.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { execFile } from "node:child_process";
|
|
2
2
|
import { promisify } from "node:util";
|
|
3
3
|
const exec = promisify(execFile);
|
|
4
|
-
async function run(cmd, args, cwd) {
|
|
5
|
-
return exec(cmd, args, { cwd });
|
|
4
|
+
async function run(cmd, args, cwd, timeoutMs) {
|
|
5
|
+
return exec(cmd, args, { cwd, timeout: timeoutMs });
|
|
6
6
|
}
|
|
7
7
|
export async function checkPrerequisites() {
|
|
8
8
|
let git = false;
|
|
@@ -73,7 +73,7 @@ export async function gitCommit(message, cwd) {
|
|
|
73
73
|
await run("git", ["commit", "-m", message], cwd);
|
|
74
74
|
}
|
|
75
75
|
export async function gitPush(cwd) {
|
|
76
|
-
await run("git", ["push"], cwd);
|
|
76
|
+
await run("git", ["push"], cwd, 3_000);
|
|
77
77
|
}
|
|
78
78
|
export async function hasUnpushedCommits(cwd) {
|
|
79
79
|
try {
|
|
@@ -93,5 +93,5 @@ export async function gitAddRemote(fullName, cwd) {
|
|
|
93
93
|
await run("git", ["remote", "add", "origin", url], cwd);
|
|
94
94
|
}
|
|
95
95
|
export async function gitPushFirst(cwd) {
|
|
96
|
-
await run("git", ["push", "-u", "origin", "main"], cwd);
|
|
96
|
+
await run("git", ["push", "-u", "origin", "main"], cwd, 3_000);
|
|
97
97
|
}
|