https://github.com/leongraumans/squashy
Effortlessly update your squash activities in Strava with Squashy
https://github.com/leongraumans/squashy
cli squash strava typescript
Last synced: about 1 month ago
JSON representation
Effortlessly update your squash activities in Strava with Squashy
- Host: GitHub
- URL: https://github.com/leongraumans/squashy
- Owner: leongraumans
- License: mit
- Created: 2024-12-12T19:22:53.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-02-10T04:30:03.000Z (3 months ago)
- Last Synced: 2025-02-12T17:28:02.425Z (3 months ago)
- Topics: cli, squash, strava, typescript
- Language: TypeScript
- Homepage:
- Size: 38.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Squashy 🎾
Effortlessly update your squash activities in Strava with **Squashy**, a lightweight CLI tool
designed for squash enthusiasts. Ideal for those whose smartwatches don't natively support squash as
an activity type, Squashy bridges the gap between your game and Strava.
---
## 🚀 Features
- **Activity Correction**: Perfect if you are already syncing your squash activities automatically
to Strava, but as the wrong sport type (e.g. "Workout"). This tool updates those activities so
that they're marked as a squash match.
- **Simple Configuration**: Easy setup with your Strava API credentials.
---
## 🛠️ Getting Started
### 1️⃣ Prerequisites
To use Squashy, you'll need a Strava API application. Follow the [Strava Developer
Guide](https://developers.strava.com/docs/getting-started/) to create your app and obtain the
following:
- `STRAVA_CLIENT_ID`
- `STRAVA_CLIENT_SECRET`
- `STRAVA_REFRESH_TOKEN`
- `STRAVA_USER_ID`
### 2️⃣ Setup
1. Clone this repository.
2. Copy the example environment file and fill in your Strava API credentials:
```bash
cp .env.example .env
```
3. Install dependencies:
```bash
pnpm i
```
### 3️⃣ Sync Activities
Run the following command to sync your activities:
```bash
pnpm squashy
```
For detailed usage options, check the built-in help:
```bash
pnpm squashy --help
```
---
## 📜 License
Squashy is open-source software licensed under the MIT License. See the [LICENSE](LICENSE) file for
details.
---
## 🌟 Contribute
We welcome contributions! If you have ideas, bug fixes, or features you'd like to add, feel free to
open an issue or submit a pull request.
---
Enjoy syncing and keep smashing those squash games! 🎾