Update README with bun commands and add .env setup
This commit is contained in:
17
.env.example
17
.env.example
@@ -1,9 +1,8 @@
|
|||||||
NUXT_OAUTH_STRAVA_CLIENT_ID=[YOUR_STRAVA_CLIENT_ID]
|
NUXT_OAUTH_STRAVA_CLIENT_ID=your_client_id
|
||||||
NUXT_OAUTH_STRAVA_CLIENT_SECRET=[YOUR_STRAVA_CLIENT_SECRET]
|
NUXT_OAUTH_STRAVA_CLIENT_SECRET=your_client_secret
|
||||||
NUXT_SESSION_PASSWORD=[YOUR_SESSION_PASSWORD]
|
NUXT_SESSION_PASSWORD=your_session_password_min_32_chars
|
||||||
NUXT_STRAVA_VERIFY_TOKEN=[YOUR_STRAVA_VERIFY_TOKEN]
|
NUXT_STRAVA_VERIFY_TOKEN=your_verify_token
|
||||||
NUXT_OPENAI_API_KEY=[YOUR_OPENAI_API_KEY]
|
NUXT_OPENAI_API_KEY=your_openai_api_key
|
||||||
NUXT_PUBLIC_APTABASE_APP_KEY=[YOUR_APTABASE_APP_KEY]
|
NUXT_DATABASE_URL=file:./tmp/ghostwriter.db
|
||||||
NUXT_WEBHOOKS_URL=[YOUR_WEBHOOKS_URL]
|
NUXT_HOOKDECK_KEY=your_hookdeck_key
|
||||||
NUXT_DATABASE_URL=[YOUR_DATABASE_URL]
|
NUXT_OPENROUTER_API_KEY=your_openrouter_api_key
|
||||||
NUXT_HOOKDECK_KEY=[YOUR_HOOKDECK_KEY]
|
|
||||||
|
|||||||
53
README.md
53
README.md
@@ -2,24 +2,47 @@
|
|||||||
|
|
||||||
## Strava Activity Title & Description Generator
|
## Strava Activity Title & Description Generator
|
||||||
|
|
||||||
Ghostwriter is a Nuxt-based application that helps athletes generate fun and creative titles and descriptions for your Strava activities.
|
Ghostwriter is a Nuxt app that conjures up the most hilarious, epic, and mildly unhinged titles and descriptions for your Strava activities. Because let's be honest, "Morning Run" doesn't quite capture the chaos of dodging dogs at 6 AM.
|
||||||
|
|
||||||
## Installation
|
Built with Nuxt 4, Bun (it's fast, duh), Drizzle ORM, and @nuxt/ui. Powers through your Strava data like a caffeinated marathoner.
|
||||||
|
|
||||||
1. Clone the repository:
|
## Quick Start
|
||||||
|
|
||||||
|
1. Copy the example env file:
|
||||||
```bash
|
```bash
|
||||||
git clone [repository_url]
|
cp .env.example .env
|
||||||
```
|
```
|
||||||
2. Navigate to the project directory:
|
|
||||||
|
2. Install and run:
|
||||||
```bash
|
```bash
|
||||||
cd ghostwriter
|
bun install
|
||||||
|
bun run dev
|
||||||
```
|
```
|
||||||
3. Install dependencies:
|
|
||||||
```bash
|
Open http://localhost:3000 and start ghostwriting those activities into legend.
|
||||||
npm install
|
|
||||||
```
|
## Commands
|
||||||
4. Run the development server:
|
|
||||||
```bash
|
| Command | What it does |
|
||||||
npm run dev
|
|---------|--------------|
|
||||||
```
|
| `bun run dev` | Spin up the dev server |
|
||||||
5. Access the application at http://localhost:3000
|
| `bun run build` | Build for production |
|
||||||
|
|
||||||
|
## Tech Stack
|
||||||
|
|
||||||
|
- **Nuxt 4** — The skeleton
|
||||||
|
- **Bun** — Runtime so fast it's basically cheating
|
||||||
|
- **Drizzle ORM** — Database wizardry
|
||||||
|
- **@nuxt/ui v3** — Beautiful UI components
|
||||||
|
- **SQLite** — Your data's cozy little home
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
1. Fork it
|
||||||
|
2. Create a branch (`git checkout -b fix-that-bug-i-guess`)
|
||||||
|
3. Commit your changes
|
||||||
|
4. Push and open a PR
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Ghostwriter: Making your Strava activities slightly less embarrassing since 2025.*
|
||||||
|
|||||||
Reference in New Issue
Block a user