https://github.com/waynewbishop/bishop-app-runbuddy-swift

Plan your next run using Generative AI. Implemented in Swift.
https://github.com/waynewbishop/bishop-app-runbuddy-swift

Last synced: about 1 month ago
JSON representation

Plan your next run using Generative AI. Implemented in Swift.

• Host: GitHub
• URL: https://github.com/waynewbishop/bishop-app-runbuddy-swift
• Owner: waynewbishop
• Created: 2024-04-22T21:05:35.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-10-09T01:18:27.000Z (3 months ago)
• Last Synced: 2024-11-01T20:37:30.069Z (3 months ago)
• Language: Swift
• Size: 194 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Run Buddy

====================

This project utilizes [Generative AI](https://www.linkedin.com/in/waynebishop) to help runners plan their next training run or event. Implemented in Swift, Run Buddy integrates training, location and statistical weather information with Google's [Gemini API](https://ai.google.dev) to provide answers for frequently asked running questions. This includes suggested strategies for nutrition, hydration, clothing and overall performance. 

Audience

---------------------

To best utilize this project, you should already be familiar with the basics of Swift. This project also aims to provide an alternative for learning the basics of adding **Generative AI** to a project or existing workflow. While many Run Buddy concepts are functional, users are welcome to submit pull requests for new features or to complete stubbed areas of planned functionality. To userstand the code, developers should be familar with Swift-specific features such as optionals, extensions, protocols and generics. Beyond Swift, audiences should be familiar with **Singleton** and **Factory** and **Binding** design patterns along with sets, arrays and dictionaries.

```swift 

let model = newTextModel(with: key)

let prompt: String = prompt

let contentStream = model.generateContentStream(prompt)

        

do {

    for try await chunk in contentStream {

        if let text = chunk.text {

            print(text)

            

            //update published property on main thread

            DispatchQueue.main.async {

                self.chunkResponse += text

            }

        }

    }

} //end do

catch {

    //throw general exception

    print("something went wrong..")

    throw error

}

```

Configuration

---------------------

To run this project, you will need to provide your own API key and set up the configuration file. Follow these steps:

1. Create a new file called `BuddyConfig.plist` in the project directory.

2. Open the `BuddyConfig.plist` file and add the following content, replacing `MyApiKey` with your actual API key:

```xml

    MyAPIKey

    your_api_key_value_here

```

Usage

--------------------

Individuals are welcome to use the code with commercial and open-source projects. As a courtesy, please provide attribution to [Wayne Bishop](https://www.linkedin.com/in/waynebishop). For more information, review the complete [license agreement](https://github.com/waynewbishop/SwiftStructures/blob/master/License.md). 

Questions

--------------------

Have a question? Feel free to contact me on [LinkedIn](https://www.linkedin.com/in/waynebishop).