Repository files navigation

What's new: In addition to the desktop apps there's now a web version of Winds available athttps://winds.getstream.io/

Due to overwhelming success of Wind's launch we could use a bit of help. We're hiring a remote Node fullstack dev to work on this open source project fulltime. Contacttommaso@getstream.io for details. Due to budget limitations the position is a better match for developers outside of the US.

Winds is a beautiful open-source RSS and Podcast app created using React/Redux/Node. Use the free hosted version or run it on your own server and customize it as you see fit. Contributions are always appreciated. In fact we're planning a series of tutorials to help you get started. Activity Feeds & Discovery in Winds are powered byStream, the app leveragesAlgolia for search,AWS for hosting,MongoDB Atlas for a hosted database (DBaaS), andSendGrid for email. All of these services have a free tier.

• Roadmap
• Powered By
  • Stream
  • Algolia
  • MongoDB
  • SendGrid
  • AWS
• Tutorials
• Download
• Contributing to Winds
• Support
• Maintenance & Contributions

Help us improve Winds and/or vote on theRoadmap for 2.1

• Mark Read (partially implemented)
• Playlist support (partially implemented)
• Team support (share an activity feed with colleagues or friends to discover and collaborate)
• Mobile application powered by React Native
• SSO (Google & Twitter)
• Folder Support
• Listen to feed changes in realtime

1. Express
2. React &Redux
3. Algolia
4. MongoDB Atlas
5. SendGrid
6. Bull
7. Mercury
8. Stream
9. Sentry
10. AWS

The full stack can be found onStackShare.io.

Stream is an API for building activity feeds. For Winds the follow suggestions and the list of articles from the feeds you follow is powered by Stream. Stream accounts are free for up to 3 million feed updates and handle personalization (machine learning) for up to 100 users.

Algolia is used for lightning fast and relevant search. We use theirJavaScript search client to easily setup the Winds search implementation. Algolia, accounts are free up to 10k records and 100k operations.

MongoDB Atlas provides a Database as a Service, and serves as the backend datastore for Winds.

The following tutorials will not only help you start contributing to Winds, but also provide inspiration for your next app.

Note: We're actively working on this portion of the README. To stay up to date with the latest information, please signup for the hosted version athttps://getstream.io/winds.

1. Architecting a large React/Redux codebase
2. Building activity streams and newsfeeds on top of Stream
3. Implementing search with Algolia
4. Deploying to AWS ECS
5. MongoDB database schema design
6. Design thought process for Winds 2.0
7. PM2 in production environments
8. Creating a RESTful API design with Express.js
9. Preparing an Electron app for deployment to the macOS store
10. Deploying to the macOS store
11. Electron gotchas

To download Winds 2.0, visithttps://getstream.io/winds/.

Commands:

• brew install pkg-config cairo redis mongodb
• brew services start mongodb
• brew services start redis
• cd winds/api
• yarn
• cd ../app
• yarn

Sign up for both Stream and Algolia, and create the following.env file in theapp directory, replacing the keys where indicated:

DATABASE_URI=mongodb://localhost/WINDSCACHE_URI=redis://localhost:6379JWT_SECRET=some-super-secret-arbitrary-jwt-stringAPI_PORT=8080REACT_APP_API_ENDPOINT=http://localhost:8080STREAM_API_BASE_URL=https://windspersonalization.getstream.io/personalization/v1.0STREAM_APP_ID=YOUR_STREAM_APP_IDSTREAM_API_KEY=YOUR_STREAM_API_KEYSTREAM_API_SECRET=YOUR_STREAM_API_SECRETREACT_APP_ALGOLIA_APP_ID=YOUR_ALGOLIA_APP_IDREACT_APP_ALGOLIA_SEARCH_KEY=YOUR_ALGOLIA_SEARCH_ONLY_API_KEYALGOLIA_WRITE_KEY=YOUR_ALGOLIA_ADMIN_API_KEYMERCURY_KEY=YOUR_KEY_HERE

Then run:

• pm2 start process_dev.json
• cd app && yarn start

git clone git@github.com:GetStream/winds.git

The following instructions are geared towards Mac users who can usebrew (Homebrew) to install most dependencies. Ubuntu users can useapt, and Windows users will have to install directly from the dependency's site. Non-debian-based Linux users will probably be able to figure it out on their own :)

• cd Winds/app
• yarn
• cd ../api
• yarn

A.env file contains all configuration and connection strings for Winds.

Create a new file titled.env inside theapp folder, and add the following:

DATABASE_URI=mongodb://localhost/WINDSCACHE_URI=redis://localhost:6379JWT_SECRET=some-super-secret-arbitrary-jwt-stringAPI_PORT=8080REACT_APP_API_ENDPOINT=http://localhost:8080STREAM_API_BASE_URL=https://windspersonalization.getstream.io/personalization/v1.0MERCURY_KEY=YOUR_API_KEY_HERE

Winds uses MongoDB as the main datastore - it contains all users, rss feeds, podcasts, episodes, articles, and shares.

If you're on a Mac, you can install MongoDB throughHomebrew by running:

brew install mongodb

(You can also install MongoDB from theofficial MongoDB site.)

You can also run MongoDB in the background by running:

brew services start mongodb

At Stream, we use Redis as an in-memory storage for the Winds podcast processing and RSS processing workers. It contains a list of podcasts and RSS feeds, which the workers pick up and process using thebull messaging system.

If you're on a Mac, you can install Redis throughHomebrew by running:

brew install redis

(You can also install Redis from theofficial Redis site.)

Then, start Redis by running:

redis-server

...which creates (by default) adump.rdb file in your current directory and stores a cached version of the database in that location.

You can also run Redis in the background by running:

brew services start redis

To contribute to Winds, sign up forStream to utilize the activity and timeline feeds.

(Reminder: Stream is free for applications with less than 3,000,000 updates per month.)

• Sign up for Stream here
• Create a new Stream app
• Find the App ID, API Key, and API Secret for your new Stream app

Append the Stream App ID, API Key, and API secret to your.env file:

STREAM_APP_ID=YOUR_STREAM_APP_IDSTREAM_API_KEY=YOUR_STREAM_API_KEYSTREAM_API_SECRET=YOUR_STREAM_API_SECRET

Once you've signed in, create "feed groups" for your Stream app.

A "feed group" defines a certain type of feed within your application. Use the "Add Feed Group" button to create the following feeds:

It's fine to enable "Realtime Notifications" for each of these feed groups, though we won't be using those yet.

In addition to Stream, you also need to sign up forAlgolia, to contribute to Winds, for the search functionality.

(Algolia is free for applications with up to 10k records.)

• Sign up for Algolia here
• From theApplications page, click "New Application" and create a new Algolia application. (We recommend something similar tomy-winds-app)
  • (Select the datacenter that's closest to you.)
• From the application page, select "Indices" and click "Add New Index". (We recommend something similar towinds-main-index)

From your app, click the "API Keys" button on the left to find your app ID and API keys.

Append your Algolia application ID, search-only API Key and Admin API Key to your.env file to look like this:

REACT_APP_ALGOLIA_APP_ID=YOUR_ALGOLIA_APP_IDREACT_APP_ALGOLIA_SEARCH_KEY=YOUR_ALGOLIA_SEARCH_ONLY_API_KEYALGOLIA_WRITE_KEY=YOUR_ALGOLIA_ADMIN_API_KEY

From the root directory, run:

pm2 start process_dev.json

To see logging information for all processes, run:

pm2 logs

cd app && yarn start

Build a production version of Winds by running:

./build.sh

This creates production-ready JS files in api/dist.

To run the production JS files:

pm2 start process_prod.json

Unfortunately there is no unified standard for RSS. To test your preferred feed, go toapi/src/workers and run:

babel-node feed_debug.js --rss https://techcrunch.com/feed/

For podcasts run:

babel-node feed_debug.js --podcast https://www.npr.org/rss/podcast.php\?id\=510289

Pull requests for improved RSS compatibility are much appreciated.Most of the parsing codebase is located inapi/src/workers/parsers.js.

All support is handled viaGitHub Issues. If you're unfamiliar with creating an Issue on GitHub, please followthese instructions.

Thank you to all of the maintainers and contributors who've helped Winds become what it is today and help it stay up and running every day. We couldn't do it without you!

• Hackernoon
• Product Hunt

• Nick Parsons
• Ken Hoff
• Thierry Schellenbach
• Josh Tilton

• Tommaso Barbugli
• Dwight Gunning
• Matt Gauger
• Zhomart Mukhamejanov
• Julian Xhokaxhiu
• Jonathon Belotti
• The Gitter Badger
• Meriadec Pillet
• Alex Sinnott
• Lawal Sauban

RSS is an amazing open standard. It is probably the most pleasant way to stay up to date with the sites and podcasts you care about. Our reasons for contributing to Winds are explained in the blogpostWinds 2.0 It's time to Revive RSS. In this section we will list other open source and commercial projects that are having an impact on Reviving RSS:

• Miniflux
• TwitRSSMe
• Feedly
• NewsBlur
• Feedity