Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 2.99 KB

README.md

File metadata and controls

65 lines (48 loc) · 2.99 KB
Raw

SMRY.ai

SMRY.ai: Revolutionizing article reading and paywall bypass with the power of AI. This tool generates summaries and gets past hard to avoid paywalls by using archive.org, googlebot, and (soon) archive.is, harnessing the advanced capabilities of OpenAI's ChatGPT API and the Vercel AI SDK. Experience seamless streaming and real-time responses with our edge computing approach.

How it Works

SMRY.ai integrates the ChatGPT API with the Vercel AI SDK to offer a streamlined, efficient summary generation process. By utilizing edge streaming, we ensure fast, responsive interactions. For insights into similar technologies, explore RSC With Streaming.

Running Locally

To run SMRY.ai in your local environment:

  1. Clone the Repository: Start by cloning the repo to your local machine.
  2. Set Up Environment Variables:
    • Navigate to OpenAI to obtain your API key.
    • Create a .env file in your project root based on the .env.example provided.
    • Ensure you have valid Vercel/Upstash KV keys. Optionally, acquire Resend Labs keys from Resend.
  3. Installation:
    • Run pnpm install to install the necessary dependencies.
  4. Starting the Application:
    • Execute pnpm run dev to start the application.
    • Access the application at http://localhost:3000.

Requirements

  • PNPM package manager

Contributing

Contributions are VERY welcome!

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For support or queries, reach out to me at [[email protected]].

Acknowledgements

Special thanks to any contributors who make the ui nicer or the paywall bypass more robust. Really curious if we can make the best such open source tool!

MIT License Section for README

## License

MIT License

Copyright (c) 2023 SMRY

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.