https://github.com/d3caf/breddit

A Reddit client for Elixir built on OAuth2. It's called Breddit because all the good Reddit/Elixir puns were taken and I like bread.
https://github.com/d3caf/breddit

elixir elixir-lang oauth2 reddit reddit-api

Last synced: about 1 month ago
JSON representation

A Reddit client for Elixir built on OAuth2. It's called Breddit because all the good Reddit/Elixir puns were taken and I like bread.

• Host: GitHub
• URL: https://github.com/d3caf/breddit
• Owner: d3caf
• Created: 2022-02-24T14:52:33.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-28T13:24:24.000Z (almost 3 years ago)
• Last Synced: 2024-10-29T08:40:46.598Z (about 2 months ago)
• Topics: elixir, elixir-lang, oauth2, reddit, reddit-api
• Language: Elixir
• Homepage:
• Size: 20.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🍞 Breddit

The Reddit client that's as delicious as bread. It's also gluten-free!

> **Note! This is still in heavy development!** It's almost definitely not prod-ready and isn't yet fully tested. PRs are welcomed to add more modules. I'm using Breddit in an app that I'm writing and adding resources as I need them.

## Installation

The package can be installed

by adding `breddit` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:breddit, "~> 0.1.0"}

  ]

end

```

## Setup

Breddit requires some configs in order to properly authenticate with Reddit.

Here is a sample config:

```elixir

config :breddit,

  oauth: [

    client_id: System.get_env("REDDIT_CLIENT_ID"), # required

    client_secret: System.get_env("REDDIT_CLIENT_SECRET"), # required

    redirect_uri: System.get_env("REDDIT_REDIRECT_URI") # required; must match the uri you provided to reddit when creating the app

  ],

  # optional, but you'll most likely at least want to add `scope` since it'd be useless to be authenticated with no scope.

  params: %{state: "1", scope: "identity edit flair history mysubreddits privatemessages read report save submit"}

```

## Usage

More docs to come... I will be adding moduledocs, specs, etc ASAP!

## Contributing

Feel free to open PRs to add additional modules! As mentioned previously, I'm using this in a separate app and am adding resources as I need them. If there's a resource you need that's not added, please add it :)