From 17b530d86c2f7012a18fbb00266cf9ed395f4ce4 Mon Sep 17 00:00:00 2001 From: Reinaldy Rafli Date: Fri, 9 Jul 2021 19:22:56 +0700 Subject: [PATCH] docs: updated to make everything clear --- .github/FUNDING.yml | 1 + README.md | 18 +++--------------- api/README.md | 16 ++++++++-------- client/README.md | 32 +++++++++++++++++--------------- 4 files changed, 29 insertions(+), 38 deletions(-) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..35ba041 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +ko_fi: aldy505 \ No newline at end of file diff --git a/README.md b/README.md index 0e9797b..a08e30e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Jokes Bapak2 API -⚠ Still work in progress +👋 Hey there! Still work in progress, if you'd like to contribute this while this repo is still growing, that would be so great! ## Brief explanation of what is this @@ -9,7 +9,7 @@ This project will be a website like icanhazdadjokes but in Indonesian version an ## Project Directories * `api` - REST API service. Created with Go. -* `client` - Front facing website (front end). Created with Vite.js +* `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: @@ -38,16 +38,4 @@ See README files on each project directory for further instruction on how to run ## License -Copyright 2021-present Jokes Bapak2 API Contributors - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. \ No newline at end of file +Jokes Bapak2 API is licensed under [GNU GENERAL PUBLIC LICENSE v3 license](./LICENSE) \ No newline at end of file diff --git a/api/README.md b/api/README.md index e1b35d5..8007037 100644 --- a/api/README.md +++ b/api/README.md @@ -21,14 +21,14 @@ $ go build main.go | Name | Version | Type | | --- | --- | --- | -| gofiber/fiber | v2.14.0 | Framework | -| jackc/pgx | v4.11.0 | Database | -| go-redis/redis | v8.11.0 | Cache | -| joho/godotenv | v1.3.0 | Config | -| getsentry/sentry-go | v0.11.0 | Logging | -| aldy505/phc-crypto | v1.1.0 | Utils | -| Masterminds/squirrel | v1.5.0 | Utils | -| aldy505/bob | v0.0.1 | Utils | +| [gofiber/fiber](https://github.com/gofiber/fiber) | `v2.14.0` | Framework | +| [jackc/pgx](https://github.com/jackc/pgx) | `v4.11.0` | Database | +| [go-redis/redis](https://github.com/go-redis/redis) | `v8.11.0` | Cache | +| [joho/godotenv](https://github.com/joho/godotenv) | `v1.3.0` | Config | +| [getsentry/sentry-go](https://github.com/getsentry/sentry-go) | `v0.11.0` | Logging | +| [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 | ## Directory structure diff --git a/client/README.md b/client/README.md index bada234..d966306 100644 --- a/client/README.md +++ b/client/README.md @@ -1,25 +1,27 @@ -# create-svelte +# Jokes Bapak2 API -Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte); +Still work in progress - -## Developing - -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: +## Development ```bash -yarn dev +# Install modules +$ yarn install + +# Run local server +$ yarn dev # or start the server and open the app in a new browser tab -yarn dev -- --open -``` +$ yarn dev -- --open -## Building - -Before creating a production version of your app, install an [adapter](https://kit.svelte.dev/docs#adapters) for your target environment. Then: - -```bash -yarn build +# build everything +$ yarn build ``` > You can preview the built app with `yarn preview`, regardless of whether you installed an adapter. This should _not_ be used to serve your app in production. + +## Used packages + +| Name | Version | Type | +| --- | --- | --- | +| @sveltejs/kit | `next` | Framework | \ No newline at end of file