Skip to content
This repository has been archived by the owner on Dec 6, 2023. It is now read-only.

Commit

Permalink
improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Qasim Sarfraz committed Feb 4, 2020
1 parent 249ceb9 commit 78d62f1
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/moodboard
/.idea
/rollout.sh
/dist
3 changes: 2 additions & 1 deletion .goreleaser.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,5 @@ changelog:
filters:
exclude:
- '^docs:'
- '^test:'
- '^test:'
- '^images'
29 changes: 24 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
<p align="left">
<a href="https://hub.docker.com/r/smqasims/moodboard" alt="Pulls">
<img src="https://img.shields.io/docker/pulls/smqasims/moodboard" /></a>
<a href="https://mqasimsarfraz.github.io/" alt="Maintained">
<img src="https://img.shields.io/maintenance/yes/2020.svg" /></a>

</p>

# Moodboard
This tool will help show your team mood using a giphy GIF.
A fun board tool to show your team mood using a giphy GIF.

[![Moodboard Demo](https://media.giphy.com/media/XDiQzh0JawsC0EDxiE/giphy.gif)](https://media.giphy.com/media/XDiQzh0JawsC0EDxiE/giphy.gif)

We use it at our workplace and we love it.

## Installation
```
docker pull smqasims/moodboard
docker run --rm -d -p 80:3080 --name moodboard smqasims/moodboard
docker run --rm -d -p 80:3080 --name moodboard smqasims/moodboard:v1.0.2
```
if you run above on `example.com` then moodboard will be available at http://example.com
if you run above on `example.com` then moodboard will be available at http://example.com.

You can also try out the platform specific binaries (e.g Raspberry Pi) in the [release](https://github.com/MQasimSarfraz/moodboard/releases) section of the project which start with a default port `3080`

## API
The moodboard starts with a default mood of `hello world` but you can update it using following:
Expand All @@ -18,5 +32,10 @@ curl -XPUT localhost/mood/happy
```
or use the [client](https://github.com/MQasimSarfraz/moodboard/blob/master/mood.sh).

## Form
You can also use a simple form to update the mood by browsing to the path `/mood/form`.

[![Moodboard Form Demo](https://raw.githubusercontent.com/MQasimSarfraz/moodboard/master/images/form.png)](https://raw.githubusercontent.com/MQasimSarfraz/moodboard/master/images/form.png)

### Rate limiting
By default moodboard will use giphy public beta key to talk to giphy API which is rate limited to `1000` requests per day. To avoid hitting rate limit you can get your [personal token](https://support.giphy.com/hc/en-us/articles/360020283431-Request-A-GIPHY-API-Key) and setting it using `GIPHY_API_KEY` env variable.
By default moodboard will use giphy public beta key to talk to giphy API which is rate limited to `1000` requests per day. To avoid hitting rate limit you can get your [personal token](https://support.giphy.com/hc/en-us/articles/360020283431-Request-A-GIPHY-API-Key) and setting it using `GIPHY_API_KEY` environment variable while launching your container.
Binary file added images/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 78d62f1

Please sign in to comment.