Skip to content

Commit

Permalink
More apps, readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kingmeers committed Jul 30, 2023
1 parent 434b669 commit 8460d3a
Show file tree
Hide file tree
Showing 415 changed files with 27,680 additions and 1 deletion.
170 changes: 169 additions & 1 deletion README.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# High School Sports Article AI Writer

High School Sports Article AI Writer is your efficient AI journalist for high school sports. With an ability to customize variables, this app uses AI to craft comprehensive sports articles tailored for students and journalism clubs. Tackling more than just a recap, it delivers in-depth coverage, including setting details, play-by-play assessments, significant moment analysis and personal quotes for an engaging narrative. Besides being thrilling, the content explores insightful evaluations going beyond basic reporting.

To run this app online: [High School Sports Article AI Writer Online](https://hero.page/app/high-school-sports-article-ai-writer-ai-powered-high-school-sports-journalism/81Xqy2B7MUYAUq3diSuN)

[![Run High School Sports Article AI Writer Online](/assets/run.svg)](https://hero.page/app/high-school-sports-article-ai-writer-ai-powered-high-school-sports-journalism/81Xqy2B7MUYAUq3diSuN)

To learn more about AI Apps for Sports Journalism Club Member use-cases in the High School Students - Sports industry, read [How to Elevate High School Sports Journalism with AI Tools](https://hero.page/blog/ai/high-school-students-sports/how-to-elevate-high-school-sports-journalism-with-ai-tools/170972)

### What is HeroML?
HeroML is an AI Prompt Chain/Workflow interpreter for Apps built on https://hero.page

To see other apps, visit the [Hero Apps](https://hero.page/apps) page or explore [AI Apps for all industries](https://hero.page/blog) in the blog section

For more documentation, visit [Hero docs, and learn about AI App Workflows](https://hero.page/tutorials/introduction-to-heroml)

Download [VSCode Syntax Highlighter Ext. here](https://marketplace.visualstudio.com/items?itemName=hero-page.heroml)

## Run with HeroCLI (Requires OpenAI Token)

#### Installation

To install the HeroML CLI tool, you need to have Node.js and npm (comes with Node.js) installed on your machine. If you don't have these, please install them first.

Then, run the following command in your terminal:

```bash
npm install -g heroml
```

This will install the HeroML CLI tool globally on your system, allowing you to use the `hero` command from any directory.

If you don't want to install it globally, you can run:

```bash
npm install heroml
```

and use it like:

```bash
npx hero run ./high_school_sports_article_ai_writer.heroml
```

We'll be using `hero run ...` in this tutorial for simplicity.

#### Configuration

Before using the HeroML CLI tool, you need to configure your OpenAI API key.

Create a `heroconfig.json` file in your home directory with the following content:

```json
{
"openaiApiKey": "your-openai-api-key"
}
```

Replace `"your-openai-api-key"` with your actual OpenAI API key.

#### Usage

To run a HeroML script, use the `run` command followed by the path to your script:

```bash
hero run ./high_school_sports_article_ai_writer.heroml
```

You can provide initial variable values as command-line options. For example, if your script expects a variable named `number_of_colors`, you can provide its value as follows:

```bash
hero run --number_of_colors 4 ./high_school_sports_article_ai_writer.heroml
```

If you do not provide a value for a variable, the HeroML CLI tool will prompt you to enter it interactively.

### Output Options

You can specify the output directory and the filename of the output file using command-line options:

- The `-o` or `--output-dir` option allows you to specify the output directory. By default, it is `./outputs/`.

```bash
hero run --output-dir /custom/output/directory ./high_school_sports_article_ai_writer.heroml
```

- The `-f` or `--filename` option allows you to specify the filename of the output file. By default, it is `response_TIMESTAMP.json`.

```bash
hero run --filename custom_filename.json ./high_school_sports_article_ai_writer.heroml
```

The CLI tool writes the output to a JSON file in the specified directory. It will print the path of the output file to the console:

```bash
Success! Output written to /custom/output/directory/custom_filename.json
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"id": "81Xqy2B7MUYAUq3diSuN"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
For writing a "Sport Article" in the "High School Students - Sports" industry for a "Sports Journalism Club Member":

{{step_1}}: Generate a catchy headline for the sports article that captivates the readers. The headline should highlight the main event or theme of the game.

Here's some more context about the Sport Article:
Headline: {{headline}}
Introduction: {{introduction}}
Event Details: {{event_details}}
Game Summary: {{game_summary}}
Key Moments Analysis: {{key_moments_analysis}}
Quotes: {{quotes}}
Conclusion: {{conclusion}}

->>>>

We have a captivating headline for our sports article:

Headline:
{{step_1}}

{{step_2}}: Now, let's proceed to the next step, which is creating an engaging introduction. This introduction should provide a brief overview of the game's topic and clearly state the purpose of the article.

->>>>

We now have a headline and an engaging introduction for our sports article:

Headline:
{{step_1}}

Introduction:
{{step_2}}

{{step_3}}: Our next step is to detail the time, venue, and teams or player involved in the game. This will give the reader a clear understanding of the setting.

->>>>

Our article now has a headline, introduction, and details about the event:

Headline:
{{step_1}}

Introduction:
{{step_2}}

Event Details:
{{step_3}}

{{step_4}}: Let's now move on to describe the play-by-play action or sequence of events in the game. This should cover the essential moments, strategic tactics, players' performances, and scores.

->>>>

We now have the headline, introduction, event details, and a vivid account of the game:

Headline:
{{step_1}}

Introduction:
{{step_2}}

Event Details:
{{step_3}}

Game Summary:
{{step_4}}

{{step_5}}: Next, analyze and advise on the key moments or turning points in the game. Discuss how these impacted the final outcome.

->>>>

Our article is coming together. We have the headline, introduction, event details, game summary, and commentary on key moments:

Headline:
{{step_1}}

Introduction:
{{step_2}}

Event Details:
{{step_3}}

Game Summary:
{{step_4}}

Key Moments Analysis:
{{step_5}}

{{step_6}}: To add depth to the article, incorporate quotes from players, coaches, or spectators. This will provide more perspectives and an authentic feel to the piece.

->>>>

Our sports article now has a headline, introduction, event details, game summary, key moments analysis, and insights from players, coaches, or spectators:

Headline:
{{step_1}}

Introduction:
{{step_2}}

Event Details:
{{step_3}}

Game Summary:
{{step_4}}

Key Moments Analysis:
{{step_5}}

Quotes:
{{step_6}}

{{step_7}}: Lastly, compose a conclusion that summarizes the game's result, discusses potential implications, and includes your final thoughts.

Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# High School Sports Interview Builder

High School Sports Interview Builder app lets you specify various variables to prompt AI to generate customized assessments in high school sports. Discover a detailed look into the life of a high school sports journalism club member, including their background, daily routine, knowledge in sports, future aspirations and advice for newcomers. The output emphasizes the balance between sports and academics, and offers educational insights into sports rules, strategies, and team dynamics. Unique to our app, you get a comprehensive understanding of sports journalism at the high school level, a rarely discussed subject.

To run this app online: [High School Sports Interview Builder Online](https://hero.page/app/high-school-sports-interview-builder-personalized-high-school-sports-insights/QJsom4DtWx0yi0UlvyZj)

[![Run High School Sports Interview Builder Online](/assets/run.svg)](https://hero.page/app/high-school-sports-interview-builder-personalized-high-school-sports-insights/QJsom4DtWx0yi0UlvyZj)

To learn more about AI Apps for Sports Journalism Club Member use-cases in the High School Students - Sports industry, read [How to Elevate High School Sports Journalism with AI Tools](https://hero.page/blog/ai/high-school-students-sports/how-to-elevate-high-school-sports-journalism-with-ai-tools/170972)

### What is HeroML?
HeroML is an AI Prompt Chain/Workflow interpreter for Apps built on https://hero.page

To see other apps, visit the [Hero Apps](https://hero.page/apps) page or explore [AI Apps for all industries](https://hero.page/blog) in the blog section

For more documentation, visit [Hero docs, and learn about AI App Workflows](https://hero.page/tutorials/introduction-to-heroml)

Download [VSCode Syntax Highlighter Ext. here](https://marketplace.visualstudio.com/items?itemName=hero-page.heroml)

## Run with HeroCLI (Requires OpenAI Token)

#### Installation

To install the HeroML CLI tool, you need to have Node.js and npm (comes with Node.js) installed on your machine. If you don't have these, please install them first.

Then, run the following command in your terminal:

```bash
npm install -g heroml
```

This will install the HeroML CLI tool globally on your system, allowing you to use the `hero` command from any directory.

If you don't want to install it globally, you can run:

```bash
npm install heroml
```

and use it like:

```bash
npx hero run ./high_school_sports_interview_builder.heroml
```

We'll be using `hero run ...` in this tutorial for simplicity.

#### Configuration

Before using the HeroML CLI tool, you need to configure your OpenAI API key.

Create a `heroconfig.json` file in your home directory with the following content:

```json
{
"openaiApiKey": "your-openai-api-key"
}
```

Replace `"your-openai-api-key"` with your actual OpenAI API key.

#### Usage

To run a HeroML script, use the `run` command followed by the path to your script:

```bash
hero run ./high_school_sports_interview_builder.heroml
```

You can provide initial variable values as command-line options. For example, if your script expects a variable named `number_of_colors`, you can provide its value as follows:

```bash
hero run --number_of_colors 4 ./high_school_sports_interview_builder.heroml
```

If you do not provide a value for a variable, the HeroML CLI tool will prompt you to enter it interactively.

### Output Options

You can specify the output directory and the filename of the output file using command-line options:

- The `-o` or `--output-dir` option allows you to specify the output directory. By default, it is `./outputs/`.

```bash
hero run --output-dir /custom/output/directory ./high_school_sports_interview_builder.heroml
```

- The `-f` or `--filename` option allows you to specify the filename of the output file. By default, it is `response_TIMESTAMP.json`.

```bash
hero run --filename custom_filename.json ./high_school_sports_interview_builder.heroml
```

The CLI tool writes the output to a JSON file in the specified directory. It will print the path of the output file to the console:

```bash
Success! Output written to /custom/output/directory/custom_filename.json
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"id": "QJsom4DtWx0yi0UlvyZj"
}
Loading

0 comments on commit 8460d3a

Please sign in to comment.