Image API for Indonesian dad jokes / Jokes Bapak2
Go to file
Reinaldy Rafli 544530cd27 test: get handler test 2021-07-17 18:25:03 +07:00
.github ci: foresee problem with pull request 2021-07-16 16:11:11 +07:00
api test: get handler test 2021-07-17 18:25:03 +07:00
client fix(meta): config 2021-07-17 00:27:06 +07:00
database build: setup docker compose 2021-07-16 02:21:22 +07:00
CONTRIBUTING.md docs: updated 2021-07-16 02:21:04 +07:00
LICENSE chore: updated license to GPL-3.0 2021-07-09 13:11:33 +07:00
README.md docs: updated 2021-07-15 19:44:07 +07:00
docker-compose.yml build: setup docker compose 2021-07-16 02:21:22 +07:00
heroku.yml build: config 2021-07-15 02:13:30 +07:00

README.md

Jokes Bapak2 API

👋 Hey there! Still work in progress, if you'd like to contribute this while this repo is still growing, that would be so great!

It's on alpha phase now. You can access the front facing web on jokesbapak2.pages.dev.

Brief explanation of what is this

This project will be a website like icanhazdadjokes but in Indonesian version and it's not text, it's images. Dad jokes in Indonesia is somewhat a bit different than in US/UK because I guess here, it's a lot dumber.

Project Directories

  • api - REST API service. Created with Go with Fiber framework.
  • client - Front facing website (front end). Created with Svelte Kit.

Later you can consume this API via a website (linked in the front facing web) with a few endpoints:

  • /v1/ - Random jokes bapak2
  • /v1/id/[number] - Jokes bapak2 based on ID
  • /v1/today - Jokes bapak2 of the day

Currently I'm searching for an alternative for AWS S3 that I can use for free.

Tech stacks

  • Go (for api/back end)
  • Node.js (for client/front end)
  • Postgres
  • Redis

That's it.

Development

Two ways of doing this:

  1. Install all the tech stack on your local machine
  2. Use docker-compose (TODO)

See README files on each project directory for further instruction on how to run the development environment.

License

Jokes Bapak2 API is licensed under GNU GENERAL PUBLIC LICENSE v3 license