Add basic readme ane .env example
This commit is contained in:
16
.env.example
16
.env.example
@@ -1,7 +1,9 @@
|
|||||||
NUXT_OAUTH_STRAVA_CLIENT_ID=
|
NUXT_OAUTH_STRAVA_CLIENT_ID=[YOUR_STRAVA_CLIENT_ID]
|
||||||
NUXT_OAUTH_STRAVA_CLIENT_SECRET=
|
NUXT_OAUTH_STRAVA_CLIENT_SECRET=[YOUR_STRAVA_CLIENT_SECRET]
|
||||||
NUXT_SESSION_PASSWORD=
|
NUXT_SESSION_PASSWORD=[YOUR_SESSION_PASSWORD]
|
||||||
NUXT_WEBHOOKS_URL=
|
NUXT_STRAVA_VERIFY_TOKEN=[YOUR_STRAVA_VERIFY_TOKEN]
|
||||||
NUXT_STRAVA_VERIFY_TOKEN=
|
NUXT_OPENAI_API_KEY=[YOUR_OPENAI_API_KEY]
|
||||||
NUXT_HUB_PROJECT_KEY=
|
NUXT_PUBLIC_APTABASE_APP_KEY=[YOUR_APTABASE_APP_KEY]
|
||||||
NUXT_HOOKDECK_KEY=
|
NUXT_WEBHOOKS_URL=[YOUR_WEBHOOKS_URL]
|
||||||
|
NUXT_DATABASE_URL=[YOUR_DATABASE_URL]
|
||||||
|
NUXT_HOOKDECK_KEY=[YOUR_HOOKDECK_KEY]
|
||||||
|
|||||||
25
README.md
Normal file
25
README.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
# Ghostwriter 👻
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
1. Clone the repository:
|
||||||
|
```bash
|
||||||
|
git clone [repository_url]
|
||||||
|
```
|
||||||
|
2. Navigate to the project directory:
|
||||||
|
```bash
|
||||||
|
cd ghostwriter
|
||||||
|
```
|
||||||
|
3. Install dependencies:
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
4. Run the development server:
|
||||||
|
```bash
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
5. Access the application at http://localhost:3000
|
||||||
Reference in New Issue
Block a user