Git Product home page Git Product logo

smry's Introduction

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.

smry's People

Contributors

mrmps avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.