A free and open source Reddit reader.

This app isn't intended to be published to any app stores. For that, check out Reddit's official apps.

Apple

Google

Instead, this app is meant to provide a lean viewing experience using the free tier of Reddit's public APIs.

Building the app is a simple process.

1. Configure your dev environment for Flutter
   1. You can follow the flutter.dev install instructions.
   2. (Note that you need MacOS to build the iOS app.)
2. Once installed, clone this Git repo onto your machine
3. Plug in your device
   1. For iOS, you may need to open xcode to ensure the app can be signed and installed on your device
4. Run the app using either
   1. flutter run
   2. IDE run of main.dart

This should get the app running on your device. For the best experience, run it in Flutter's release mode.

1. flutter run --release

After building the app, you'll likely find that you can't sign in. This is because you're missing a very important bit of information:

1. client_id

This value (along with the redirect_uri) is specific to Reddit's oauth system and are required to authorize your account with this app. To actually make the app useful, you're going to need to make your own client id. Below is a link to Reddit's OAuth2 startup instructions.

1. Reddit's OAuth2 Guide

Follow this OAuth2 "Getting Started" portion. This will set up your Reddit account to being a "developer", granting you access to their OAuth APIs. Make sure you set up the app as an "installed app". (Your redirect_uri is assumed to be https://www.reddit.com)

Once you have a developer app created, make a new file in lib/app/ called secrets.dart. There, add this line of code: const clientId = ''; and populate the empty string with your client id.

todo

This project isn't currently accepting changes to its main branch. If you'd like to make a change, please fork this repo and do it yourself.

Ideas are welcome, but unlikely to be implemented. Remember, the idea is that this project is lightweight.