Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sue445/tweet_pixels

Tweet pixels
https://github.com/sue445/tweet_pixels

pixela

Last synced: about 1 month ago
JSON representation

Tweet pixels

Awesome Lists containing this project

README

        

# Tweet pixels
[![Tweet pixels](https://pixe.la/v1/users/sue445/graphs/tweets)](https://pixe.la/v1/users/sue445/graphs/tweets.html)

[![Tweet pixels](https://pixe.la/v1/users/sue445/graphs/tweets?mode=badge)](https://pixe.la/v1/users/sue445/graphs/tweets.html)
[![CircleCI](https://dl.circleci.com/status-badge/img/gh/sue445/tweet_pixels/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/sue445/tweet_pixels/tree/master)

## Features
* Regularly update the graph of tweet count. (daily and hourly)

## Requirements
* [Pixela](https://pixe.la/)
* [Twilog](https://twilog.togetter.com/)

## Usage
### 1. Register Pixela and create graph
e.g)

```bash
cp .env.example .env
vi .env
bundle install --path=vendor/bundle

./bin/console
```

```ruby
# register
@client.create_user(agree_terms_of_service: true, not_minor: true)

# create graph
@graph.create(name: "Daily tweets", unit: "Tweets", type: "int", color: "sora")
```

### 2. Register Environment Variables to CircleCI
* `TWITTER_ID`
* `PIXELA_USERNAME`
* `PIXELA_TOKEN`
* `PIXELA_GRAPH_ID`

![CircleCI](img/circleci.png)

For third party orbs, set 'Allow Uncertified Orbs' option in organization security settings.
See https://circleci.com/docs/2.0/orbs-faq/#using-3rd-party-orbs.

### 3. Register a GitHub cache url (optional)
Register a GitHub cache url (e.g. `https://camo.githubusercontent.com/xxxxxxxxxx`) after paste a badge to GitHub

e.g)

```ruby
@graph.update(purge_cache_urls: "https://camo.githubusercontent.com/xxxxxxxxxx")
```

see https://github.com/a-know/Pixela/releases/tag/v1.1.0