aldy505
/
jokes-bapak2
mirror of https://github.com/aldy505/jokes-bapak2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: updated

This commit is contained in:
Reinaldy Rafli 2021-07-15 19:44:07 +07:00
parent e1ffe651c6
commit 02e9289058
3 changed files with 62 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -2,16 +2,18 @@
👋 Hey there! Still work in progress, if you'd like to contribute this while this repo is still growing, that would be so great! 👋 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](http://jokesbapak2.pages.dev/).
## Brief explanation of what is this ## 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. 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 ## Project Directories
* `api` - REST API service. Created with Go. * `api` - REST API service. Created with Go with [Fiber](https://gofiber.io/) framework.
* `client` - Front facing website (front end). Created with [Svelte Kit](https://kit.svelte.dev/). * `client` - Front facing website (front end). Created with [Svelte Kit](https://kit.svelte.dev/).
Anyway, later you can consume this API via a website (that will be created later on when this is finished) with a few endpoints: Later you can consume this API via a website (linked in the front facing web) with a few endpoints:
* `/v1/` - Random jokes bapak2 * `/v1/` - Random jokes bapak2
* `/v1/id/[number]` - Jokes bapak2 based on ID * `/v1/id/[number]` - Jokes bapak2 based on ID

29
api/README.md
View File

@ -29,21 +29,30 @@ $ go build main.go
| [aldy505/phc-crypto](https://github.com/aldy505/phc-crypto) | `v1.1.0` | Utils | | [aldy505/phc-crypto](https://github.com/aldy505/phc-crypto) | `v1.1.0` | Utils |
| [Masterminds/squirrel](https://github.com/Masterminds/squirrel ) | `v1.5.0` | Utils | | [Masterminds/squirrel](https://github.com/Masterminds/squirrel ) | `v1.5.0` | Utils |
| [aldy505/bob](https://github.com/aldy505/bob) | `v0.0.1` | Utils | | [aldy505/bob](https://github.com/aldy505/bob) | `v0.0.1` | Utils |
| [gojek/heimdall](github.com/gojek/heimdall) | `v7.0.2` | Utils |
## Directory structure ## Directory structure
``` ```
└-- /app .
└---- /v1 ├── app
└---- /handler │ └── v1
└---- /middleware folder for add middleware │ ├── app.go - v1 application entry point
└---- /models │ ├── handler - Route handler
└---- /platform │ ├── middleware - App middleware handler
└--------- /cache folder with in-memory cache setup functions │ ├── models - Output and input schema
└--------- /database folder with database setup functions │ ├── platform
└---- /routes folder for describe routes │ │ ├── cache - In-memory cache setup functions
└---- /utils folder with utility functions │ │ └── database - Database setup functions
│ ├── routes - Routes definition & assignment
│ └── utils - Utility functions
├── Dockerfile - Docker image for API
├── go.mod - Module information & dependencies
├── go.sum - Packages lock file
├── main.go - Application entry point
└── README.md - You are here
``` ```
## `.env` configuration ## `.env` configuration
```ini ```ini

44
client/README.md
View File

@ -1,4 +1,4 @@
# Jokes Bapak2 API # Jokes Bapak2 Client
Still work in progress Still work in progress
@ -11,9 +11,6 @@ $ yarn install
# Run local server # Run local server
$ yarn dev $ yarn dev
# or start the server and open the app in a new browser tab
$ yarn dev -- --open
# build everything # build everything
$ yarn build $ yarn build
``` ```
@ -24,4 +21,41 @@ $ yarn build
| Name | Version | Type | | Name | Version | Type |
| --- | --- | --- | | --- | --- | --- |
| @sveltejs/kit | `next` | Framework | | @sveltejs/kit | `1.0.0-next.129` | Framework |
| svelte | `3.38.3` | Framework |
| typescript | `4.3.5` | Static type language |
| svelte-i18n | `3.3.9` | i18n Library |
| svelte-windicss-preprocess | `4.0.12` | CSS Library |
| @fontsource/fira-mono | `4.5.0` | Webfont |
| @fontsource/rubik | `4.5.0` | Webfont |
| dotenv | `10.0.0` | Utils |
| @sentry/browser | `6.9.0` | Logging |
## Directory structure
```
.
├── Dockerfile - Docker image for client
├── package.json - Meta information & dependencies
├── README.md - You are here
├── src
│ ├── app.html - HTML entry point
│ ├── components - Svelte component files
│ ├── global.d.ts - Global type definition for Typescript
│ ├── languages - i18n localization database
│ ├── lib - Logic & utilities
│ └── routes - Svelte page files
├── static - Static/public directory
├── svelte.config.js - Svelte configuration file
├── tsconfig.json - Typescript configuration file
├── windi.config.js - WindiCSS configuration file
└── yarn.lock - Packages lock file
```
## `.env` configuration
```ini
VITE_NODE_ENV=development
VITE_API_ENDPOINT=
VITE_SENTRY_DSN=
```