diff --git a/README.md b/README.md index ed4c20d..fb1d060 100644 --- a/README.md +++ b/README.md @@ -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! +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 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. +* `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/). -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/id/[number]` - Jokes bapak2 based on ID diff --git a/api/README.md b/api/README.md index 8007037..457db08 100644 --- a/api/README.md +++ b/api/README.md @@ -29,21 +29,30 @@ $ go build main.go | [aldy505/phc-crypto](https://github.com/aldy505/phc-crypto) | `v1.1.0` | Utils | | [Masterminds/squirrel](https://github.com/Masterminds/squirrel ) | `v1.5.0` | Utils | | [aldy505/bob](https://github.com/aldy505/bob) | `v0.0.1` | Utils | +| [gojek/heimdall](github.com/gojek/heimdall) | `v7.0.2` | Utils | ## Directory structure ``` -└-- /app - └---- /v1 - └---- /handler - └---- /middleware folder for add middleware - └---- /models - └---- /platform - └--------- /cache folder with in-memory cache setup functions - └--------- /database folder with database setup functions - └---- /routes folder for describe routes - └---- /utils folder with utility functions +. +├── app +│ └── v1 +│ ├── app.go - v1 application entry point +│ ├── handler - Route handler +│ ├── middleware - App middleware handler +│ ├── models - Output and input schema +│ ├── platform +│ │ ├── cache - In-memory cache setup 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 ```ini diff --git a/client/README.md b/client/README.md index d966306..4f32340 100644 --- a/client/README.md +++ b/client/README.md @@ -1,4 +1,4 @@ -# Jokes Bapak2 API +# Jokes Bapak2 Client Still work in progress @@ -11,9 +11,6 @@ $ yarn install # Run local server $ yarn dev -# or start the server and open the app in a new browser tab -$ yarn dev -- --open - # build everything $ yarn build ``` @@ -24,4 +21,41 @@ $ yarn build | Name | Version | Type | | --- | --- | --- | -| @sveltejs/kit | `next` | Framework | \ No newline at end of file +| @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= +``` \ No newline at end of file