• This repository has been archived on 12/Oct/2021
  • Stars
    star
    8,813
  • Rank 4,129 (Top 0.09 %)
  • Language
    JavaScript
  • License
    BSD 3-Clause "New...
  • Created about 8 years ago
  • Updated about 3 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A Beautiful Open Source RSS & Podcast App Powered by Getstream.io

🛑 Notice: This repository is no longer maintained; No further Issues or Pull Requests will be considered or approved.

Winds - A Beautiful Open Source RSS & Podcast App Powered by GetStream.io

Slack Community Build Status codecov Open Source Maintenance Built With StackShare

Description

Winds is a beautiful open-source RSS and Podcast app created using React & Redux on the frontend and Express.js on the backend. Use the free hosted version or run it on your own server and customize it as you see fit. Contributions in form of pull requests are always appreciated. Activity Feeds & Discovery in Winds are powered by Stream, the app leverages Algolia for search, AWS for hosting, MongoDB Atlas for a hosted database (DBaaS), and SendGrid for email. All of these services have a free tier.

Getting Started

To get started with Winds, please download the latest release

Featured RSS & Podcasts

Have a popular RSS or Podcast and want to be featured? Reach out to [email protected]. We reply to every message.

Features at a Glance

Winds is packed full of awesome features behind a beautiful user interface and user experience. Here's a quick look at what the project has to offer:

Beautiful UI

Winds UI

RSS & Podcast Recommendations

Winds RSS & Podcast Recommendations

Integrated Search

Winds Search

Podcast Player

Winds Podcast Player

RSS Reader

Winds RSS Reader

TOCd

Roadmap

Help us improve Winds and/or vote on the Roadmap for 2.1

  • Search detail screen
  • Playlist support (partially implemented)
  • Team support (share an activity feed with colleagues or friends to discover and collaborate)
  • Mobile application powered by React Native

Powered By

  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 on StackShare.io.

Stream

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

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

MongoDB

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

Tutorials & Blog Posts

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 at https://getstream.io/winds.

  1. Implementing search with Algolia
  2. Stream and Winds
  3. Running PM2 & Node.js in Production Environments
  4. Creating a RESTful API design with Express.js
  5. Takeaways on Building a React Based App with Electron
  6. The Winds Stack
  7. Building Touch Bar Support for macOS in Electron with React
  8. Testing Node.js in 2018
  9. Simple Steps to Optimize Your App Performance with MongoDB, Redis, and Node.js
  10. Getting Started with Winds & Open Source
  11. Deploying the Winds App to Amazon S3 and CloudFront
  12. Deploying the Winds API to AWS ECS with Docker Compose

Download

To download Winds, visit https://getstream.io/winds/.

Contributing to Winds

TL;DR

Commands:

  • brew install redis mongodb
  • brew services start mongodb
  • brew services start redis
  • cd Winds
  • cd api && yarn
  • cd ../app && yarn

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

DATABASE_URI=mongodb://localhost/WINDS_DEV
CACHE_URI=redis://localhost:6379
JWT_SECRET=YOUR_JWT_SECRET

API_PORT=8080
REACT_APP_API_ENDPOINT=http://localhost:8080
STREAM_API_BASE_URL=https://windspersonalization.getstream.io/personalization/v1.0

STREAM_APP_ID=YOUR_STREAM_APP_ID
REACT_APP_STREAM_APP_ID=YOUR_STREAM_APP_ID
REACT_APP_STREAM_API_KEY=YOUR_STREAM_API_KEY
REACT_APP_STREAM_ANALYTICS=YOUR_STREAM_ANALYTICS_TOKEN
STREAM_API_KEY=YOUR_STREAM_API_KEY
STREAM_API_SECRET=YOUR_STREAM_API_SECRET

REACT_APP_ALGOLIA_APP_ID=YOUR_ALGOLIA_APP_ID
REACT_APP_ALGOLIA_SEARCH_KEY=YOUR_ALGOLIA_SEARCH_ONLY_API_KEY
ALGOLIA_WRITE_KEY=YOUR_ALGOLIA_ADMIN_API_KEY

Note: If you are running the test suite, you will need to have a test version of the .env file inside of the api/test directory.

Then run:

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

Clone the Repo

git clone [email protected]:GetStream/Winds.git

Install dependencies

The following instructions are geared towards Mac users who can use brew (Homebrew) to install most dependencies. Ubuntu users can use apt, 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

Start MongoDB Locally

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 through Homebrew by running:

brew install mongodb

(You can also install MongoDB from the official MongoDB site.)

You can also run MongoDB in the background by running:

brew services start mongodb

Start Redis Locally

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 the bull messaging system.

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

brew install redis

(You can also install Redis from the official Redis site.)

Then, start Redis by running:

redis-server

...which creates (by default) a dump.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

Loading Test Data

For testing purposes, you will want to use the test data located here.

Use mongoimport or mongorestore to import the data. There are two username and password combinations for testing:

Username: [email protected]
Password: admin

Username: [email protected]
Password: test

You will need to run the FLUSHALL command in Redis to ensure that the new content is picked up.

Note: This will override any local data that you may have. Please be cautious! Also, this will not create Stream follows – please follow feeds manually to generate them.

Stream

Sign up and Create a Stream App

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

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

Add your Stream App ID, API Key, and API Secret to your .env

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

STREAM_APP_ID=YOUR_STREAM_APP_ID
STREAM_API_KEY=YOUR_STREAM_API_KEY
STREAM_API_SECRET=YOUR_STREAM_API_SECRET

Create Your Stream Feed Groups

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:

Feed Group Name Feed Group Type
podcast flat
rss flat
user flat
timeline flat
folder flat
user_episode flat
user_article flat

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

Algolia

Sign up for Algolia and Create an Algolia App and Index

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

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

  • Sign up for Algolia here
  • From the Applications page, click "New Application" and create a new Algolia application. (We recommend something similar to my-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 to winds-main-index)

Add Your Algolia Application Id, Search-Only Api Key and Admin Api Key to Your .env File

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_ID
REACT_APP_ALGOLIA_SEARCH_KEY=YOUR_ALGOLIA_SEARCH_ONLY_API_KEY
ALGOLIA_WRITE_KEY=YOUR_ALGOLIA_ADMIN_API_KEY

Start Backend Services

From the root directory, run:

pm2 start process_dev.json

To see logging information for all processes, run:

pm2 logs

Start Frontend Electron / Web App Server

cd app && yarn start

Running tests

Winds API server uses:

Tests are located in api/test folder.

File structure is intentionally mirroring files in api/src to simplify matching tests to tested code.

To run tests:

cd api && yarn run test

To run tests with extended stack traces (useful when debugging async issues):

cd api && yarn run test_deep

Adding new tests

Add your code to a file in api/test folder (preferably mirroring existing file from api/src folder).

Refer to Mocha documentation for examples of using BDD-like DSL for writing tests.

Modules are mocked in api/test-entry.js as mocks have to be installed before any modules are loaded.

Fixtures are loaded via loadFixture function from api/test/fixtures folder

Various utility functions are provided in api/test/util.js (See other tests for examples of usage).

Building a Production Version

Build a production version of Winds by running from root directory:

./api/build.sh

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

To run the production JS files:

pm2 start process_prod.json

OR

Prepare the build for Docker:

cd api && cd scripts && ./make-build.sh

Build the Docker container (API & all workers):

cd ../ && docker-compose up

The commands above will prepare and start the API (and all workers). The frontend will still need to be started manually.

Debugging RSS & Podcast Issues

Unfortunately there is no unified standard for RSS. Go to the api directory and run yarn link to make these commands available:

winds rss https://techcrunch.com/feed/

Podcasts:

winds podcast https://www.npr.org/rss/podcast.php\?id\=510289

Open Graph scraping:

winds og http://www.planetary.org/multimedia/planetary-radio/show/2018/0509-amy-mainzer-neowise.html

RSS Discovery:

winds discover mashable.com

Article parsing (w/ Mercury):

winds article https://alexiskold.net/2018/04/12/meet-12-startups-from-techstars-nyc-winter-2018-program/

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

Support

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

Maintenance and Contributions

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!

Special Shoutouts To:

Primary Maintainers

Contributors

Revive RSS

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 blogpost Winds 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:

We are hiring!

We've recently closed a $38 million Series B funding round and we keep actively growing. Our APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world.

Check out our current openings and apply via Stream's website.

More Repositories

1

stream-chat-android

💬 Android Chat SDK ➜ Stream Chat API. UI component libraries for chat apps. Kotlin & Jetpack Compose messaging SDK for Android chat
Kotlin
1,443
star
2

vg

Virtualgo: Easy and powerful workspace based development for go
Go
1,311
star
3

whatsApp-clone-compose

📱 WhatsApp clone project demonstrates modern Android development built with Jetpack Compose and Stream Chat/Video SDK for Compose.
Kotlin
1,254
star
4

stream-react-example

Use React and Redux to build your own feature-rich and scalable social network app! Visit cabin.getstream.io for an overview of all 8 tutorials and a live demo.
HTML
923
star
5

stream-chat-flutter

Flutter Chat SDK - Build your own chat app experience using Dart, Flutter and the Stream Chat Messaging API.
Dart
839
star
6

stream-chat-react-native

💬 React-Native Chat SDK ➜ Stream Chat. Includes a tutorial on building your own chat app experience using React-Native, React-Navigation and Stream
TypeScript
792
star
7

purposeful-ios-animations

Meaningful iOS animations built to inspire you in creating useful animations for your apps. Each of the animations here was cloned with SwiftUI. Have you seen an app animation you love to rebuild and add to this repo?, contact [@amos_gyamfi](https://twitter.com/amos_gyamfi) and [@stefanjblos](https://twitter.com/stefanjblos) on Twitter.
Swift
763
star
8

stream-chat-swift

💬 iOS Chat SDK in Swift - Build your own app chat experience for iOS using the official Stream Chat API
Swift
750
star
9

swiftui-spring-animations

This repository serves as your reference and complete guide for SwiftUI Spring Animations. It demonstrates use cases for the various types of spring animations and spring parameters. No more guessing the values of the parameters for spring animations you create for your next iOS app.
Swift
692
star
10

webrtc-android

🛰️ A versatile WebRTC pre-compiled Android library that reflects the recent WebRTC updates to facilitate real-time video chat for Android and Compose.
Kotlin
578
star
11

stream-chat-react

React Chat SDK ➜ Stream Chat 💬
TypeScript
552
star
12

awesome-saas-services

A curated list of the best in class SaaS services for developers and business owners.
475
star
13

stream-django

Django Client - Build Activity Feeds & Streams with GetStream.io
Python
453
star
14

sketchbook-compose

🎨 Jetpack Compose canvas library that helps you draw paths, images on canvas with color pickers and palettes.
Kotlin
442
star
15

avatarview-android

✨ Supports loading profile images with fractional styles, shapes, borders, indicators, and initials for Android.
Kotlin
432
star
16

webrtc-in-jetpack-compose

📱 This project demonstrates WebRTC protocol to facilitate real-time video communications with Jetpack Compose.
Kotlin
402
star
17

stream-video-android

📲 Android Video SDK. Stream's versatile Core + Compose UI component libraries that allow you to build video calling, audio room, and, live streaming apps based on Webrtc running on Stream's global edge network.
Kotlin
374
star
18

AvengersChat

💙 Android sample Avengers chat application using Stream Chat SDK based on MVVM (ViewModel, Coroutines, Room, Hilt, Repository) architecture.
Kotlin
367
star
19

stream-draw-android

🛥 Stream Draw is a real-time multiplayer drawing & chat game app built entirely with Jetpack Compose.
Kotlin
341
star
20

stream-chat-swiftui

SwiftUI Chat SDK ➜ Stream Chat 💬
Swift
329
star
21

stream-js

JS / Browser Client - Build Activity Feeds & Streams with GetStream.io
JavaScript
329
star
22

effects-library

The Effects Library allows developers to create sophisticated and realistic particle systems such as snow, fire, rain, confetti, fireworks, and smoke with no or minimal effort.
Swift
324
star
23

react-native-example

React Native Activity Feed example application
JavaScript
321
star
24

stream-laravel

Laravel Client - Build Activity Feeds & Streams with GetStream.io
PHP
314
star
25

flutter-samples

A collection of sample apps that use Stream
Dart
298
star
26

stream-rails

Rails Client - Build Activity Feeds & Streams with GetStream.io
Ruby
257
star
27

Streamoji

:godmode: Custom emoji rendering library for iOS apps with support for GIF & still images - plug-in extension for UITextView - performance, cache ✅ - Made with 💘 by @GetStream
Swift
248
star
28

react-native-bidirectional-infinite-scroll

📜 React Native - Bidirectional Infinite Smooth Scroll
TypeScript
220
star
29

WhatsApp-Clone-Android

Tutorial which teaches you how to build a whatsapp chat clone on android using Kotlin, viewmodels, navigation component and Stream
Kotlin
218
star
30

butterfly

🦋 Butterfly helps you to build adaptive and responsive UIs for Android with Jetpack WindowManager.
Kotlin
214
star
31

slack-clone-react-native

Build a slack clone using react-native, Stream and react-navigation
JavaScript
206
star
32

react-native-activity-feed

Official React Native SDK for Activity Feeds
JavaScript
194
star
33

motionscape-app

MotionScape is your animations playground as a developer. You can see all animations and their parameters in effect with beautifully designed and handcrafted animation examples.
Swift
167
star
34

Android-Samples

📕 Provides a list of samples that utilize modern Android tech stacks and Stream Chat SDK for Android and Compose.
Kotlin
159
star
35

node-express-mongo-api

Starter project for a REST API with Node.js, Express & MongoDB 🔋
JavaScript
151
star
36

stream-chat-js

JS / Browser Client - Build Chat with GetStream.io
TypeScript
149
star
37

meeting-room-compose

🎙️ A real-time meeting room app built with Jetpack Compose to demonstrate video communications.
Kotlin
141
star
38

stream-php

PHP Client - Build Activity Feeds & Streams with GetStream.io
PHP
139
star
39

stream-log

🛥 Stream Log is a lightweight and extensible logger library for Kotlin Multiplatform.
Kotlin
136
star
40

react-activity-feed

Stream React Activity Feed Components
TypeScript
136
star
41

stream-python

Python Client - Build Activity Feeds & Streams with GetStream.io
Python
136
star
42

flat-list-mvcp

"maintainVisibleContentPosition" prop support for Android react-native
TypeScript
133
star
43

stream-node-orm

NodeJS Client - Build Activity Feeds & Streams with GetStream.io
JavaScript
131
star
44

website-react-examples

TypeScript
122
star
45

stream-video-swift

SwiftUI Video SDK ➡️ Stream Video 📹
Swift
117
star
46

react-native-samples

A collection of sample apps built using GetStream and React Native
JavaScript
116
star
47

flutter-instagram-clone

An Instagram clone using Flutter and Stream Feeds
Dart
111
star
48

django_twitter

An example app built using getstream.io
Python
108
star
49

twitter-clone

Learn how to build a functional Twitter clone using Stream, 100ms, Algolia, RevenueCat and Mux 😎
Swift
107
star
50

accessible-inclusive-ios-animations

Provide ways to limit animations/motion people find jarring in your apps. This repo demonstrates accessible and inclusive iOS animations/motion with practical examples and best practices.
Swift
107
star
51

stream-result

🚊 Railway-oriented library to easily model and handle success/failure for Kotlin Multiplatform.
Kotlin
102
star
52

Stream-Example-Nodejs

An example app built using getstream.io
JavaScript
96
star
53

Android-Video-Samples

📘 Provides a collection of samples that utilize modern Android tech stacks and Stream Video SDK for Kotlin and Compose.
Kotlin
88
star
54

react-native-audio-player

JavaScript
86
star
55

stream-ruby

Ruby Client - Build Activity Feeds & Streams with GetStream.io
Ruby
83
star
56

stream-tutorial-projects

This repo contains SwiftUI, Jetpack Compose, JS & React Native projects for some of the iOS and Android tutorial series in the Stream Developers YouTube channel (https://youtube.com/playlist?list=PLNBhvhkAJG6tJYnY-5oZ1JCp2fBNbVL_6).
Swift
83
star
57

stream-chat-unity

💬 Unity Chat Plugin by Stream ➜ These assets are the solution for adding an in-game text chat system to your Unity game.
C#
83
star
58

stream-go2

GetStream.io Go client
Go
82
star
59

stream-cli

Configure & manage Stream applications from the command line. 🚀
Go
80
star
60

mongodb-activity-feed

Activity Feed, Timeline, News Feed, Notification Feed with MongoDB, Node and CRDTs
JavaScript
77
star
61

android-video-chat

⚡️ Android Video Chat demonstrates a real-time video chat application by utilizing Stream Chat & Video SDKs.
Kotlin
76
star
62

TinyGraphQL

🌸 Simple and lightweight GraphQL query builder for the Swift language - Made with 💘 by @GetStream
Swift
76
star
63

slack-clone-expo

Slack clone using Expo, Stream and react-navigation
JavaScript
75
star
64

liveshopping-android

📹 A demo app showcasing real-time livestreaming and messaging capabilities built with Jetpack Compose and Stream SDKs.
Kotlin
74
star
65

fullstack-nextjs-whatsapp-clone

A sample codebase showcasing Stream Chat and Video to resembling WhatsApp, using NextJS, TailwindCSS and Vercel.
TypeScript
72
star
66

stream-feed-flutter

Stream Feed official Flutter SDK. Build your own feed experience using Dart and Flutter.
Dart
69
star
67

stream-chat-go

Stream Chat official Golang API Client
Go
67
star
68

stream-video-js

GetStream JavaScript Video SDK
TypeScript
66
star
69

discord-clone-nextjs

Building a discord clone using NextJS, TailwindCSS, and the Stream Chat and Audio and Video SDKs.
TypeScript
64
star
70

SwiftUIMessagesUIClone

The SwiftUI Messages Clone consists of layout and composition clones of the iOS Messages app. It has Messages-like bubble and screen effects, reactions, and animations, all created with SwiftUI.
Swift
62
star
71

Stream-Example-Py

An example app built using getstream.io
CSS
61
star
72

encrypted-web-chat

A web chat application end-to-end encrypted with the Web Crypto API
JavaScript
59
star
73

swift-lambda

λ Write HTTP services in Swift, deploy in seconds - Powered by AWS Lambda Runtime & Serverless Framework - Made with 💘 by @GetStream
Swift
57
star
74

stream-chat-python

Stream Chat official Python API Client
Python
56
star
75

stream-java

Java Client - Build Activity Feeds & Streams with GetStream.io
Java
53
star
76

stream-video-flutter

Flutter Video SDK - Build your own video app experience using Dart, Flutter and the Stream Video Messaging API.
Dart
46
star
77

Stream-Example-Parse

Stream-Example-Parse
JavaScript
46
star
78

Stream-Example-PHP

An example app built using getstream.io https://getstream.io
PHP
46
star
79

android-chat-tutorial

Sample apps for the Stream Chat Android SDK's official tutorial
Java
46
star
80

stream-meteor

Meteor Client - Build Activity Feeds & Streams with GetStream.io
JavaScript
45
star
81

SwiftUIChristmasTree

🌲 Pure SwiftUI christmas tree with yearly updates. Enjoy 🎄
Swift
45
star
82

python-chat-example

Chat with Python, Django and React
JavaScript
44
star
83

stream-chat-net

Stream Chat official .NET API Client
C#
43
star
84

stream-chat-dart

Dart SDK - Build Chat with GetStream.io
Dart
42
star
85

kmp-sample-template

A minimal Kotlin & Compose Multiplatform template designed to build applications for both Android and iOS.
Kotlin
41
star
86

Stream-Example-Go-Cassandra-API

Go-powered API example using Cassandra
Go
38
star
87

Stream-Example-Rails

An example app built using getstream.io
Ruby
38
star
88

Stream-Example-Android

Java
38
star
89

foldable-chat-android

🦚 Foldable chat Android demonstrates adaptive and responsive UIs with Jetpack WindowManager API.
Kotlin
35
star
90

stream-net

NET Client - Build Activity Feeds & Streams with GetStream.io
C#
35
star
91

stream-swift

Swift client for Stream API
Swift
35
star
92

stream-chat-angular

💬 Angular Chat SDK ➜ Stream Chat. Build a chat app with ease.
TypeScript
34
star
93

SwiftUI-open-voip-animations

SwiftUI animations and UI designs for iOS calling, meeting, audio-room, and live streaming use cases. Find something missing? Let @amos_gyamfi know on Twitter.
33
star
94

node-restify-mongo-api

Starter project for a REST API with Node.js, Restify & MongoDB 🔋
JavaScript
32
star
95

stream-chat-unreal

The official Unreal SDK for Stream Chat
C++
32
star
96

build-viking-sample

Sample app for Build Viking.
Dart
31
star
97

swiftui-iMessage-clone

Swift
30
star
98

swift-activity-feed

Stream Swift iOS Activity Feed Components
Swift
29
star
99

stream-chat-ruby

Stream Chat official Ruby API Client
Ruby
29
star
100

sign-in-with-apple-swift-example

iOS + Node.js authentication using Sign in with Apple
Swift
28
star