2.8.0 • Published 5 years ago

fieriframes v2.8.0

Weekly downloads
-
License
MIT
Repository
github
Last release
5 years ago

Hello from Flavortown

Bold Flavors

This is the source code behind Fieri Frames. If you're here, you must love existential angst and bold flavors. Who can blame you?

This bot is powered by another terrible library I wrote, called stills.

To change the way the stills generator works, you're really going to have to change the stills engine. So these instructions will show you how to pull down that repo and link things up locally so you dev on both the fieriframes bot (which, again, does nothing) and the underlying engine.

Setup

Dependencies

  1. See the stills README
  2. nvm: curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash

stills engine

  1. git clone https://github.com/shahkashani/stills.git
  2. cd stills
  3. nvm install
  4. npm install
  5. npm link
  6. cd ../

fieriframes bot

  1. git clone https://github.com/shahkashani/fieriframes.git
  2. cd fieriframes
  3. nvm install
  4. npm install
  5. npm link stills

Now, any changes you make to stills will automatically be picked up by fieriframes. If you make something cool, please make a PR from your stills fork against the master repo.

How do I generate a still?

Run node index.js --help

This should explain most things.

Usually while developing, you'd put a bunch of videos in videos/ run node index.js --local=videos or npm run generate.

You can also pick a type of image to generate instead of letting the generator pick, e.g. node index.js --local=videos --type=gif (or --type=still).

S3

To pick an image from a video in S3 instead of locally, add the following variables in an .env file at root and then omit the --local parameter above.

S3_ACCESS_KEY_ID=
S3_SECRET_ACCESS_KEY=
S3_BUCKET=

How do I post?

Run node index.js --post or npm run post

If you wanna post to Tumblr, you're gonna need variables defined in an .env file:

TUMBLR_CONSUMER_KEY=
TUMBLR_CONSUMER_SECRET=
TUMBLR_ACCESS_TOKEN_KEY=
TUMBLR_ACCESS_TOKEN_SECRET=
TUMBLR_BLOG_NAME=

And for Twitter:

TWITTER_CONSUMER_KEY=
TWITTER_CONSUMER_SECRET=
TWITTER_ACCESS_TOKEN_KEY=
TWITTER_ACCESS_TOKEN_SECRET=

Tada

I think that's it! Let me know if you run into any troubles. PRs accepted! Make a fork and open one against this repo!

2.8.0

5 years ago