Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mozillach/gh-projects-content-queue
A Twitter content curation queue based on GitHub projects.
https://github.com/mozillach/gh-projects-content-queue
board content ical issue-cards issues mozilla queue twitter
Last synced: about 1 month ago
JSON representation
A Twitter content curation queue based on GitHub projects.
- Host: GitHub
- URL: https://github.com/mozillach/gh-projects-content-queue
- Owner: mozillach
- License: mpl-2.0
- Archived: true
- Created: 2016-10-26T18:51:55.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-04-28T16:01:50.000Z (over 2 years ago)
- Last Synced: 2024-08-04T01:27:44.110Z (5 months ago)
- Topics: board, content, ical, issue-cards, issues, mozilla, queue, twitter
- Language: JavaScript
- Size: 1.73 MB
- Stars: 7
- Watchers: 6
- Forks: 8
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-list - gh-projects-content-queue
README
# gh-projects-content-queue
> This project is superceded by [content-queue](https://github.com/content-queue). The aim is to achieve the same thing but using GitHub actions. This makes the tool much easier to install, configure and run.
[](https://travis-ci.org/mozillach/gh-projects-content-queue) [](https://codecov.io/gh/mozillach/gh-projects-content-queue) [](https://hub.docker.com/r/mozillach/content-queue/builds)
A content curation queue based on GitHub projects. Originally built for tweeting. Crowd sources content
creation, improves collaboration and gives better control over content quality.
## Features
- Represent tweets as GitHub issues
- Supports replying and retweets
- Auto add unhandled mentions as new issues
- Auto add issues to a column in a dedicated project board
- Auto post issues from a column in the dedicated board
- Validate issue content to be valid for posting
- Scheduling of posts to an exact time
- Reaction squad system to ping people to react to a mention
- Auto posting from a column in certain spacing (à la buffer)
- Reminder system for posts that are due but not ready
- Auto create posts for events from an ical feed
- Auto create posts for new discourse threads
- Auto create posts for posts in an Atom or RSS feed
- Mastodon support
- Supports replying, reposts and spoilers
### Planned
- Tweet pinning management (will probably happen for Mastodon first, since there's actually an API for that there)
- See all the issues with the enhancement tag...
## Set up a repo for use with this tool
### Requirements
- GitHub user auth token (will use that to create issues and comment on them etc.)
- Log in with your GitHub user
- Go to your settings
- Go to "Personal access token" and go click on the "Generate new token" button
- Select the "public_repo" scope and if you are using it with an organization "read:org" and click save
- Add the resulting token to the `config.json` file (`accounts.github.token` property)
- Twitter API credentials incl. OAuth tokens and secret (will tweet to this account)
- Create a new App through [developer.twitter.com/apps](https://developer.twitter.com/apps)
- Apply for a developer account if you don't have one yet
- There is no need to define a redirect URL, just leave the field blank
- Copy the consumer key and secret to the fields in the `config.json` file
- Click on "Create access token"
- Copy the access token key and secret to the fields in the `config.json` file
- Mastodon OAuth access token (will toot to this account)
- In the following, replace `https://mastodoninstance.example.com` with the URL of your instance
- Create a new application at `https://mastodoninstance.example.com/settings/applications/new`
- Grant all read and write scopes. In theory the `read:accounts`, `read:statuses` and `write:statuses` should be enough at the moment, but this is untested
- Go to the application and copy the access token under "Your access token"
- The instance URL is probably `https://mastodoninstance.example.com/api/v1`
- Add both the access token and the instance URL to the fields in the `config.json` file
- Node >= 8.0.0
### Issue template
Issue templates are generated in the repository. See the documentation for GitHub issue templates.
### Configuration
[configuration.md](docs/configuration.md)
### Run
#### The tool
The tool can be executed with `npm start`. Note that you should first run `npm ci --production` or equivalent.
#### The docker container
Official Docker container: [`mozillach/content-queue`](https://hub.docker.com/r/mozillach/content-queue)
The latest tag corresponds to the master branch in this repository. Note that the docker container can only be configured via environment.
#### The tests
The test suite can be ran with the default `npm test`. It includes linting of the code using eslint and unit tests with ava. Tests require no prior configuration other than running `npm ci` and that all files from this repository be present.