Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/watsuyo/notion-rss-reader
You can save articles from your favorite sites in the Notion Database.
https://github.com/watsuyo/notion-rss-reader
esbuild githubactions nodejs notion rss typescript
Last synced: 6 days ago
JSON representation
You can save articles from your favorite sites in the Notion Database.
- Host: GitHub
- URL: https://github.com/watsuyo/notion-rss-reader
- Owner: watsuyo
- License: mit
- Created: 2022-01-10T17:05:37.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-02-23T11:08:16.000Z (11 months ago)
- Last Synced: 2025-01-09T00:24:22.143Z (13 days ago)
- Topics: esbuild, githubactions, nodejs, notion, rss, typescript
- Language: TypeScript
- Homepage: https://bit.ly/3I1zr7D
- Size: 668 KB
- Stars: 132
- Watchers: 4
- Forks: 138
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://opensource.org/)
[](https://github.com/watsuyo/notion-rss-reader/blob/master/LICENSE)
[](https://github.com/watsuyo/notion-rss-reader/issues)
[](https://github.com/watsuyo/notion-rss-reader/pulls)
[](https://github.com/watsuyo/notion-rss-reader/graphs/contributors)
[](https://github.com/watsuyo/notion-rss-reader/stargazers)
[](https://github.com/watsuyo/notion-rss-reader/watchers)
[](https://github.com/watsuyo/notion-rss-reader/fork)
[](https://twitter.com/intent/follow?screen_name=n_rss_r)
Notion RSS Reader π
[](https://bit.ly/3Jpi4h7)
## You can save articles from your favorite sites in the Notion Databaseπ
Table of Contents
## About Notion RSS Reader
## 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 π](https://bit.ly/3sqjKjK)
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`
```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](https://docs.github.com/en/actions/managing-workflow-runs/disabling-and-enabling-a-workflow#enabling-a-workflow).
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
- [x] How to use `Notion RSS Reader`
- [ ] [Feedly integration](https://github.com/watsuyo/notion-rss-reader/issues/5)
- [ ] [Awesome Browser UI](https://github.com/watsuyo/notion-rss-reader/issues/4)
etc...
See the [open issues](https://bit.ly/361C6zX) for a full list of proposed features (and known issues).
## 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"
### Prerequisites
* yarn v1
* Node v14
The author has confirmed that it works with these versions.
### Installation
1. Clone the repo
```sh
git clone [email protected]:watsuyo/notion-rss-reader.git
```
2. Install YARN packages
```sh
yarn install
```
3. Add `NOTION_FEEDER_DATABASE_ID`, `NOTION_READER_DATABASE_ID`, and `NOTION_KEY` to the `.env` file.
```.env
NOTION_KEY=secret_************
NOTION_FEEDER_DATABASE_ID=************
NOTION_READER_DATABASE_ID=************
```
4. Local run
```sh
yarn build
yarn feed
```
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
watsuyo - [@watsuyo_2](https://bit.ly/3gzFAfa)
Project Link: [https://github.com/watsuyo/notion-rss-reader/](https://bit.ly/3GFCIYq)
## Donate
[](https://bit.ly/3Jpi4h7)
[contributors-shield]: https://img.shields.io/github/contributors/watsuyo/notion-rss-reader.svg?style=for-the-badge
[contributors-url]: https://github.com/watsuyo/notion-rss-reader/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/watsuyo/notion-rss-reader.svg?style=for-the-badge
[forks-url]: https://github.com/watsuyo/notion-rss-reader/network/members
[stars-shield]: https://img.shields.io/github/stars/watsuyo/notion-rss-reader.svg?style=for-the-badge
[stars-url]: https://github.com/watsuyo/notion-rss-reader/stargazers
[issues-shield]: https://img.shields.io/github/issues/watsuyo/notion-rss-reader.svg?style=for-the-badge
[issues-url]: https://github.com/watsuyo/notion-rss-reader/issues
[license-shield]: https://img.shields.io/github/license/watsuyo/notion-rss-reader.svg?style=for-the-badge
[license-url]: https://github.com/watsuyo/notion-rss-reader/blob/master/LICENSE