Skip to content

README.md

Latest commit

 

History

History
57 lines (39 loc) · 1.66 KB

README.md

File metadata and controls

57 lines (39 loc) · 1.66 KB

Yodlr

Yodlr lets users create shoutout cards for Twitters users.

How it works

  • Step 1 - Find a Twitter user
  • Step 2 - Select card style
  • Step 3 - Edit colors
  • Step 4 - Download shoutout

Screenshot

yodlr

Packages

Getting Started

Create environmental variables

Create .env.local file in the project root and add the following content in it

TWITTER_CONSUMER_KEY=
TWITTER_CONSUMER_KEY_SECRET=
TWITTER_BEARER_TOKEN=

To get the Twitter keys, visit https://developer.twitter.com/en/portal/dashboard and create a standalone app. Fetch the consumer key, secret and bearer token and add it to the .env.local file.

Install dependencies

npm install

Run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

GNU General Public License v3.0

Credits