Reading the repo
Opening the box…
Assembly instructions
RSSNext/
🧡 Folo is the AI RSS Reader
Node.jsVite#ai#reader#rss#rss-reader
Before you start
- Is it free?
- YesOpen source (AGPL-3.0).
- Still maintained?
- Yes, activeLast change 4 days ago. Latest release mobile/v0.6.2, 13 days ago.
- How widely used?
- Widely used39k stars, 2 years old, by an organization. As with any download, get it from the official repo.
- Difficulty
- Moderate
- Time
- about 15 min
- Stars
- ★ 39,292
- Activity
- Updated this month
Saved setup from 4 h ago
Will it work on macOS?
Yes, it runs on macOS
- You'll build it yourself with Node.js.
Start here
Heads-upBuilding it yourself? It also needs 11 settings in .env (3 secret).
From the maintainersDevelopment setup: CONTRIBUTING.md
CONTRIBUTING.mdContributing to Folo
Thank you for considering contributing to Folo! We welcome contributions from the community to help improve and expand the project.
Getting Started
Before you start contributing, please ensure you have enabled Corepack. Corepack ensures you are using the correct version of the package manager specified in the package.json.
corepack enable && corepack prepare
Installing Dependencies
To install the necessary dependencies, run:
pnpm install
Development Setup
Develop in the Browser
For a more convenient development experience, we recommend developing in the browser:
cd apps/desktop && pnpm run dev:web
This will open the browser at https://app.folo.is/__debug_proxy, allowing you to access the online API environment for development and debugging.
Develop in Electron
If you prefer to develop in Electron, follow these steps:
-
Go to the
apps/desktopdirectory:cd apps/desktop -
Copy the example environment variables file:
cp .env.example .env -
Set
VITE_API_URLtohttps://api.follow.isin your.envfile. -
Run the development server:
pnpm run dev:electron
Tip: If you encounter login issues, copy the
__Secure-better-auth.session_tokenfrom your browser's cookies into the app.
Develop in External SSR Web App
To develop in SSR, follow these steps:
-
Go to the
apps/ssrdirectory:cd apps/ssr -
Run the development server:
pnpm run dev
Develop in Mobile App
To develop in the mobile app, follow these steps:
[!NOTE] You need to have a Mac device to develop in the mobile app.
And already installed Xcode and the necessary dependencies.
-
Go to the
apps/mobiledirectory:cd apps/mobile -
Copy the example environment variables file:
cp .env.example .envThen set the required environment variables in your
.envfile:echo 'EXPO_PUBLIC_APP_CHECK_DEBUG_TOKEN="xxx"' >> .envOr manually edit the
.envfile to add:EXPO_PUBLIC_APP_CHECK_DEBUG_TOKEN="xxx"the value is any string.
-
Build and install Folo(dev) app from source: (This step will take a while and only need to be done once)
pnpm expo prebuild --clean # Optional pnpm run ios -
Run the development server:
pnpm run dev
Development Native Modules
To develop native iOS modules, follow these steps:
-
Go to the
apps/mobiledirectory:cd apps/mobile/ios -
Open project in Xcode:
open Folo.xcworkspace -
Open
Podsin left sidebar and selectFollowNative:
- Build and run the project.
Contribution Guidelines
- Ensure your code follows the project's coding standards and conventions.
- Write clear, concise commit messages.
- Include relevant tests for your changes.
- Update documentation as necessary.
Community
Join our community to discuss ideas, ask questions, and share your contributions:
We look forward to your contributions!
License
By contributing to Folo, you agree that your contributions will be licensed under the GNU Affero General Public License version 3, with the special exceptions noted in the README.md.
4 steps on macOS
Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Clone the repository
Needs Git: xcode-select --install
git clone https://github.com/RSSNext/Folo.git cd Folo
Install the required runtimes
Node.js 22
# needs nvm: brew install nvm (or https://github.com/nvm-sh/nvm) nvm install nvm use
Install dependencies
corepack enable pnpm install
Run the tests
pnpm test
From the README: 👋🏻 Getting Started & Join Our Community
Folo runs in the browser and on iOS, Android, macOS, Windows and Linux, and keeps your subscriptions, read status and stars in sync across all of them. It is under active development, and feedback is welcome for any issue you run into.
| Platform | Download | | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Web | <a href="https://app.folo.is" target="_blank"><img src="https://github.com/user-attachments/assets/51ef7800-b683-4493-83e8-eb4752366997" alt="Try on the Browser" height="55"/></a> | | iOS | <a href="https://apps.apple.com/us/app/folo-follow-everything/id6739802604" target="_blank"><img src="https://github.com/user-attachments/assets/a94d8698-2a11-4f43-9b0a-b756b17b61f7" alt="Download on the App Store" height="55"/></a> | | Android | <a href="https://play.google.com/store/apps/details?id=is.follow" target="_blank"><img src="https://github.com/user-attachments/assets/0d178e0b-3ace-4f75-bbde-ab3c0a416ce8" alt="Get it on Google Play" height="55"/></a> <a href="https://github.com/RSSNext/Folo/releases/latest" target="_blank"><img src="https://github.com/user-attachments/assets/cf61e197-d756-4606-a8ad-fb591f79fdfc" alt="Download on GitHub" height="55"/></a> | | macOS | <a href="https://apps.apple.com/us/app/folo-follow-everything/id6739802604" target="_blank"><img src="https://github.com/user-attachments/assets/d8f8c877-4b1d-4a95-b400-30afe45d970e" alt="Download on the Mac App Store" height="55"/></a> <a href="https://github.com/RSSNext/Folo/releases/latest" target="_blank"><img src="https://github.com/user-attachments/assets/cf61e197-d756-4606-a8ad-fb591f79fdfc" alt="Download on GitHub" height="55"/></a> | | Windows | <a href="https://apps.microsoft.com/detail/9nvfzpv0v0ht?mode=direct" target="_blank"><img src="https://github.com/user-attachments/assets/f689d2dc-010d-432b-909e-99ab344ddbda" alt="Download from the Microsoft Store" height="55"/></a> <a href="https://github.com/RSSNext/Folo/releases/latest" target="_blank"><img src="https://github.com/user-attachments/assets/cf61e197-d756-4606-a8ad-fb591f79fdfc" alt="Download on GitHub" height="55"/></a> | | Linux | <a href="https://github.com/RSSNext/Folo/releases/latest" target="_blank"><img src="https://github.com/user-attachments/assets/cf61e197-d756-4606-a8ad-fb591f79fdfc" alt="Download on GitHub" height="55"/></a> |
You can also install using the following methods maintained by our community:
- If you are using Arch Linux, you can install the package folo-appimage that is maintained by timochan and grtsinry43.
- If you are using Linux with Flatpak, you can install Folo from FlatPark that is maintained by Komh.
- If you are using Nix, you can install the package folo that is maintained by iosmanthus.
- If you are using macOS with Homebrew, you can install the cask folo that is maintained by realSunyz.
- If you are using Windows with Scoop, you can install the manifest [folo](https://gi
…
Did you get it running?
No reports for macOS yet.
Still stuck? Get a written guide
GitManual AI Agent reads the 14 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.