Skip to content

Kudos as a service | send kudos to your loved ones! ๐Ÿ˜Š

Notifications You must be signed in to change notification settings

alfdocimo/kuaas

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

31 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ‘ Kudos as a service

Pretty self explanatory - send kudos to your friends, colleagues and loved ones!

Why?

Ah, see, that's a good question... I don't really know! It was mostly because I thought it would be fun to build!

Took a lot of inspiration from https://foaas.com/ ๐Ÿ‘ˆ but, you know, its the opposite.

Entries

The application itself consumes its own API through SWR

Which leaves us with two entry points

API

All things http://localhost:3000/api/v1 onwards refers to the API. The API handles all things related to fetching data from Giphy and formatting back a correct message for the UI

React app

All things http://localhost:3000/ (without /api) refers to the UI itself.

They both share query params as the UI sends them to the API

For example:

UI ๐Ÿ‘‡

http://localhost:3000/kudos/John%20Doe/Great%20Work/?gif=true&customMessage=&gifTag=congratulations

API ๐Ÿ‘‡

http://localhost:3000/api/v1/John%20Doe/Great%20Work/?gif=true&customMessage=&gifTag=congratulations

Running locally

Once you've cloned this repository, go ahead and run

yarn

or

npm i

Then, since this is a Next.js application simply run

yarn dev

or

npm run dev

Contributing

YES PLEASE! - Sorry I lost my cool for a second. I would love to see more people contribute to this project. I believe it has some potential ๐Ÿ˜Š

Disclaimer: please keep in mind that this is an MVP

About

Kudos as a service | send kudos to your loved ones! ๐Ÿ˜Š

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published