Home

Awesome

<div id="top"></div>

Open Source MIT License

Issues GitHub pull requests GitHub contributors GitHub stars GitHub watchers GitHub forks

Twitter Follow

<div align="center"> <h1>Notion RSS Reader 🎁</h1> </div> <div align="center"> <img src="https://user-images.githubusercontent.com/13050604/153710070-771f3912-7a53-49cb-aea1-4e71f875886c.png" alt="Logo" width="300px"> </div>

"Buy Me A Coffee"

You can save articles from your favorite sites in the Notion Database👍

<!-- TABLE OF CONTENTS --> <details> <summary>Table of Contents</summary> <ol> <li> <a href="#about-notion-rss-reader">About Notion RSS Reader</a> </li> <li> <a href="#getting-started">Getting Started</a> </li> <li><a href="#roadmap">Roadmap</a></li> <li> <a href="#contributing">Contributing</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#installation">Installation</a></li> </ul> </li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> </ol> </details> <!-- ABOUT THE PROJECT -->

About Notion RSS Reader

Notion RSS Reader Screen Shot

<!-- Notion RSS Readerは、GitHubとNotionを組み合わせたウェブサービスで、好きなサイトの記事を無料で毎時間取得し、好きなだけ保存することができます! --> <p align="right">(<a href="#top">back to top</a>)</p> <!-- GETTING STARTED -->

Getting Started

  1. Fork the Project

    You will use GitHub Actions to feed updates to the article. Therefore, you will need to Fork into your repository.

<!-- 記事の更新をフィードするために、GitHub Actions を使用する予定です。そのため、リポジトリに Fork しておく必要があります。 -->
  1. Duplicate Notion RSS Reader Template 🎁

    Duplicate Notion RSS Reader Template in your workspace.

<!-- Notion RSS Reader Templateをあなたのワークスペースに複製する -->
  1. Get NOTION_FEEDER_DATABASE_ID & NOTION_READER_DATABASE_ID

    URL contains DATABASE_ID.

    <!-- URLはDATABASE_IDを含んでいます -->

    Example: https://notion.site/${DATABASE_ID}?v=********

  2. Get NOTION_KEY(Internal Integration Token)

    Go to Notion's My integrations page and set up an integration for Notion RSS Reader.

    <img src="https://i.gyazo.com/a5ce72d2f1825bf0baa37398caf97d5b.png" width="50%"> <!-- NotionのMy integrationsページにて、Notion RSS Reader用のintegrationを設定します -->
  3. Add NOTION_FEEDER_DATABASE_ID, NOTION_READER_DATABASE_ID, and NOTION_KEY to GitHub Actions Secrets.

    <!-- GitHub Actions Secretsに、NOTION_FEEDER_DATABASE_ID, NOTION_READER_DATABASE_ID, NOTION_KEYを追加してください。 -->

    SettingsActionsRepository Secrets

  4. Set the interval to get site updates.

    Default interval, every hour.

    .github/workflows/feed.yml

    on:
      schedule:
        - cron: "0 * * * *" # UTC ← Fix this!
      workflow_dispatch:
    

    Reference: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#onschedule

  5. Enable to "GitHub Actions Workflow" and delete the release workflow file.

    For more information, please click here.

    Workflow file is only required in the original repository.

  6. Add a link to the site you want to get updates from to "Notion's Feeder database".

    Feeder

  7. Turn on 「Can edit」at Feader & Reader in Notion page and invite with the name of the integration you set in 4.

    This setting needs to be made for both Feader and Reader.

    <img width="368" alt="image" src="https://user-images.githubusercontent.com/13050604/153715571-fe4f7cf2-251d-4f72-b942-04a3353489b2.png">
  8. You can check if the settings are complete by doing a "Feed Cron" from the "Actions" tab.

    image

<!-- ROADMAP -->

Roadmap

See the open issues for a full list of proposed features (and known issues).

<p align="right">(<a href="#top">back to top</a>)</p> <!-- CONTRIBUTING -->

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". if you like it, to give the project a star! Thanks again!

  1. Fork the "Project"
  2. Create your "Feature Branch" (git checkout -b feature/AmazingFeature)
  3. Commit your "Changes" (git commit -m 'Add some AmazingFeature')
  4. Push to the "Branch" (git push origin feature/AmazingFeature)
  5. Open a "Pull Request"
<p align="right">(<a href="#top">back to top</a>)</p>

Prerequisites

The author has confirmed that it works with these versions.

<!-- 必ずしも作者のローカル環境と同じである必要はないです。 -->

Installation

  1. Clone the repo

    git clone git@github.com:watsuyo/notion-rss-reader.git
    
  2. Install YARN packages

    yarn install
    
  3. Add NOTION_FEEDER_DATABASE_ID, NOTION_READER_DATABASE_ID, and NOTION_KEY to the .env file.

    NOTION_KEY=secret_************
    NOTION_FEEDER_DATABASE_ID=************
    NOTION_READER_DATABASE_ID=************
    
  4. Local run

    yarn build
    yarn feed
    
<p align="right">(<a href="#top">back to top</a>)</p> <!-- LICENSE -->

License

Distributed under the MIT License. See LICENSE for more information.

<p align="right">(<a href="#top">back to top</a>)</p> <!-- CONTACT -->

Contact

watsuyo - @watsuyo_2

Project Link: https://github.com/watsuyo/notion-rss-reader/

<p align="right">(<a href="#top">back to top</a>)</p> <!-- DONATE -->

Donate

"Buy Me A Coffee"

<!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->