qcmuu / notion-rss-reader

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

Notion RSS Reader 🎁

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

Table of Contents

1. About Notion RSS Reader
2. Getting Started
3. Roadmap
4. Contributing
   • Prerequisites
   • Installation
5. License
6. Contact

About Notion RSS Reader

(back to top)

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.

2. Duplicate Notion RSS Reader Template 🎁

   Duplicate Notion RSS Reader Template in your workspace.

3. Get NOTION_FEEDER_DATABASE_ID & NOTION_READER_DATABASE_ID

   URL contains DATABASE_ID.

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

4. Get NOTION_KEY(Internal Integration Token)

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

   

5. Add NOTION_FEEDER_DATABASE_ID, NOTION_READER_DATABASE_ID, and NOTION_KEY to GitHub Actions Secrets.

   Settings → Actions→ Repository Secrets

   

6. 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

7. 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.

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

   

9. 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.

   

10. You can check if the settings are complete by doing a "Feed Cron" from the "Actions" tab.

    

Roadmap

• How to use Notion RSS Reader

• Feedly integration

• Awesome Browser UI

  etc...

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

(back to top)

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"

(back to top)

Prerequisites

• yarn v1
• Node v14

The author has confirmed that it works with these versions.

Installation

1. Clone the repo

   git clone [e-mail]: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

(back to top)

License

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

(back to top)

Contact

watsuyo - @watsuyo_2

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

(back to top)

Donate