octonews / octonews

A collaborative link sharing platform

octonews

A collaborative link sharing platform

Find out about the motivation and ideas for the project in ORIGIN.md

Octonews is a website rendered by Jekyll and is easy to publish to GitHub Pages. People can share links through pull requests by adding files to the _data/news folder. Instead of editing the YAML files directly, Octonews has a custom HTML form to submit links and is talking to the GitHub API to create the pull-requests automagically without people even knowing about it. All it takes is logging in with their GitHub account, which is built into Octonews, too.

The Octonews JavaScript API

All GitHub API calls are abstracted away in a higher-level API, which is implemented in [assets/octonews.js]. The Octonews object is accessible globally everywhere on the website.

Account APIs

Examples

if (Octonews.isSignedIn()) {
  // user is signed in
}

Octonews.set(key, value)
Octonews.get(key)
Octonews.unset(key)

Octonews.signIn() // redirects to GitHub to sign in
Octonews.signOut()

// fetch current user’s account information
Octonews.fetchAccount()

// fetch current user’s account information using single-use code & state
// query parameter from the GitHub OAuth redirect
Octonews.fetchAccount({code, state})
  .then(({token, scope, login, avatarUrl}) => {
    //
  })

// submit a link
Octonews.submitLink({url, tile})

// load pending link submissions
Octonews.getPendingLinks()

License

Apache 2.0

octonews's Issues

StaticMan

Here is the thing I've come across that seems relevant. https://staticman.net/

Check it out?

Needs GitHub description, topics

Currently there aren't any set! In the README you have: "A collaborative link sharing platform", which should work.

Links in pending tab are incorrect

Problem is this line

octonews/assets/octonews.js

Line 280 in c2113f1

url: pullRequest.body.match(/Title: ([^\n]+)/)[1],

We want the URL, not the title. So the correct line should be

      url: pullRequest.body.match(/Url: ([^\n]+)/)[1]

show loading indicator when signing in

after redirect from GitHub we load the user profile information, show loader while wating for response from GitHub

Add License

There isn't one? Same for Code of Conduct.

When signed out, hide submit form

show message instead asking to sign in

Add reactions

This is just for reference for my self: a GraphQL query to load reactions for merged pull requests with the octonews label

{
  repository(owner: "octonews", name: "octonews") {
    name
    pullRequests(first: 100, states: MERGED, labels: ["octonews"], orderBy: {field:CREATED_AT, direction:DESC}) {
      pageInfo {
        endCursor
      }
      edges {
        cursor
        node {
          title
          reactions(content: HEART) {
            totalCount
            viewerHasReacted
          }
        }
      }
    }
  }
}

This doesn’t give us the information if I voted up the current news or not, but it’s a start

Accidentally pushed change to main branch (didn't think I had the permission to)

Hey,

Accidentally pushed change to main branch (didn't think I had the permission to.)
Was going to do a pull request. Sorry 🙃

Submit button doesn't work as intended.

The "Submit" button background isn't clickable. Furthermore, I'm redirected to an empty page.

Rename to octonews

following conventions of octobox.io, octokit.github.io, and probably some more.

I would love love a "Paperboycat" (or something similar, would prefer sth gender-neutral) that we could use as logo :) see https://octodex.github.com/ and https://en.wikipedia.org/wiki/Paperboy_(video_game)

Progress

• move repository to @octonews
• by octonews.org
• setup https via cloudflare (pending)

Reverse the order of news

It should show news news first :)

Implement submitting a link :)

This should start a pull request creating a new file in _data/news :)

after login, redirect back to current page

set ? redirect_uri query parameter
see: https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-authorization-options-for-oauth-apps/

Support multiple sign in/out buttons

Add a welcome repository, or clean up the Org

• Show people are in it.
• Add a Contributing.md file.
• Add a CoC.
• Add a profile image for the org.

Let me know if you need help with any of this.

make login link work on submit page

Create fork if user has no write access