2021-05-02 07:49:13 +00:00
# Jokes Bapak2 API
2021-07-09 12:22:56 +00:00
👋 Hey there! Still work in progress, if you'd like to contribute this while this repo is still growing, that would be so great!
2021-05-02 07:49:13 +00:00
2021-07-15 12:44:07 +00:00
It's on alpha phase now. You can access the front facing web on [jokesbapak2.pages.dev ](http://jokesbapak2.pages.dev/ ).
2021-05-02 07:49:13 +00:00
## 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
2021-07-15 12:44:07 +00:00
* `api` - REST API service. Created with Go with [Fiber ](https://gofiber.io/ ) framework.
2021-07-09 12:22:56 +00:00
* `client` - Front facing website (front end). Created with [Svelte Kit ](https://kit.svelte.dev/ ).
2021-05-02 07:49:13 +00:00
2021-07-15 12:44:07 +00:00
Later you can consume this API via a website (linked in the front facing web) with a few endpoints:
2021-05-02 07:49:13 +00:00
* `/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
2021-07-09 12:13:45 +00:00
* Go (for `api` /back end)
* Node.js (for `client` /front end)
2021-05-02 07:58:37 +00:00
* Postgres
* Redis
2021-05-02 07:49:13 +00:00
That's it.
2021-05-02 07:58:37 +00:00
## Development
Two ways of doing this:
1. Install all the tech stack on your local machine
2021-07-09 13:46:12 +00:00
2. Use docker-compose (TODO)
2021-05-02 07:58:37 +00:00
See README files on each project directory for further instruction on how to run the development environment.
2021-05-02 07:49:13 +00:00
## License
2021-07-09 12:22:56 +00:00
Jokes Bapak2 API is licensed under [GNU GENERAL PUBLIC LICENSE v3 license ](./LICENSE )
