Summarly is an iOS app built with Swift and SwiftUI that allows you to load web articles or PDFs, analyze the content, prepare summaries, and engage in Q/A sessions with the content. The app leverages Pinecone, a vector database, for its memory feature to provide a seamless user experience.
- Load web articles and PDFs.
- Content analysis and summarization.
- Interactive Q/A sessions with the content.
- Utilizes Pinecone for memory features.
- Built using Swift and SwiftUI for iOS.
To get started with Summarly, clone this repository and open the project in Xcode. Ensure that you have the latest version of Xcode installed to avoid compatibility issues.
git clone https://github.com/ArchieGoodwin/Summarly_OSS.gitOpen Summarly.xcodeproj in Xcode and run the app on the iOS simulator or a physical device.
Before building the project, make sure to:
- Add your OpenAI API key to the info.plist file.
- Update the Pinecone URL to the index and API key in the Defaults.swift file.
- Launch the Summarly app on your iOS device.
- Choose to load a web article or a PDF file.
- The app will analyze the content and generate a summary for you.
- Engage in a Q/A session by asking questions related to the article or PDF.
- Explore the Pinecone-powered memory feature for an enhanced experience.
- Pinecone: A vector database used for the memory feature.
- Swift: The programming language used for the project.
- SwiftUI: The user interface toolkit used to build the app.
- SwiftSoup: A library for loading and parsing web content.
Contributions are welcome!
Summarly is available under the MIT license.
Copyright (c) [2023] [Sergey Dikarev]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.