Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/philhawksworth/twavatar

A utility for resolving Twitter avatar URLs from their Twitter handles, built on the JAMstack
https://github.com/philhawksworth/twavatar

jamstack lambda netlify serverless utility

Last synced: about 3 hours ago
JSON representation

A utility for resolving Twitter avatar URLs from their Twitter handles, built on the JAMstack

Awesome Lists containing this project

README

        

# Twavatar

https://twavatar.netlify.com

[![Netlify Status](https://api.netlify.com/api/v1/badges/9cf74222-c89a-454c-be61-4a076a702479/deploy-status)](https://app.netlify.com/sites/twavatar/deploys)

An API to grab Twitter avatars with just their twitter handle. Built as a [JAMstack](https://jamstack.org) site and served on [Netlify](https://netlify.com), with a sprinkling of serverless functions via [Netlify Functions](https://www.netlify.com/blog/2018/03/20/netlifys-aws-lambda-functions-bring-the-backend-to-your-frontend-workflow/)

## Usage

```
// get the URL for the avatar of any twitter user by requesting:
https://twavatar.netlify.com/{small|large}/{handle}

// for example
https://twavatar.netlify.com/large/philhawksworth

```

## One of your very own

Hopefully, this little utility is already useful, but you can also get your own version to deploy and experiment with. It is a useful example for getting started with [Netlify Functions](https://www.netlify.com/blog/2018/03/20/netlifys-aws-lambda-functions-bring-the-backend-to-your-frontend-workflow/)

## Instructions

To get your own instance of this example site up and running on Netlify very quickly, just click the button below and follow the instructions.

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/philhawksworth/twavatar)

## Wait, what happens when I click that button?

Good question. Here's what it will do...

1. Netlify will clone the git repository of this project into your Github account. It will be asking for permission to add the repo for you.
2. We'll create a new site for you in Netlify, and configure it to use your shiny new repo. Right away you'll be able to deploy changes simply by pushing changes to your repo.
3. That's it really.