From f73b91b79e3f326b8a4ec767203471dbc447d928 Mon Sep 17 00:00:00 2001 From: AmdaaRaijen Date: Fri, 26 May 2023 17:38:10 +0700 Subject: [PATCH] update readme.md & installation.md --- .env.example | 1 + README.md | 8 ++++++-- installation.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 49 insertions(+), 2 deletions(-) create mode 100644 installation.md diff --git a/.env.example b/.env.example index b764541..e704344 100644 --- a/.env.example +++ b/.env.example @@ -8,6 +8,7 @@ LOG_CHANNEL=stack LOG_LEVEL=debug XENDIT_SECRET_KEY=xnd_development +XENDIT_CALLBACK_TOKEN=xnd_development DB_CONNECTION=mysql DB_HOST=127.0.0.1 diff --git a/README.md b/README.md index 15e71e1..5b0b0f4 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ ![Dashboard image](https://github.com/AmdaaRaijen/berbagi/assets/95063290/da114ba4-ef1d-408f-8f21-c831d68cfb78) ![Donation Page Image](https://github.com/AmdaaRaijen/berbagi/assets/95063290/2633495c-2469-43a0-990a-812dbdf81ab1) - ## Features - Connect to Xendit @@ -12,7 +11,7 @@ ## Demo You could try the demo at -https://donasi.insanpeduli.org +https://demo.donazy.org Email: superadmin@example.com Password: secret @@ -26,6 +25,11 @@ Password: secret If you want to know how to install this app, please refer to this [Installation Guide](./installation.md) +## API Documentation + +Check our API documentation +https://documenter.getpostman.com/view/20104631/2s93m4WMfM + ## Community & Group Discussion You could join us at Telegram Group https://t.me/+YJBH4-sZatBiOWE1 diff --git a/installation.md b/installation.md new file mode 100644 index 0000000..f309f36 --- /dev/null +++ b/installation.md @@ -0,0 +1,42 @@ +## Installation + +Clone this repository and install all dependency first + +```sh +composer install +yarn +``` + +Setup .env by copying .env.example file. Generate the laravel key after that. + +```sh +php artisan key:generate + +``` + +Here's the thing. In the .env, you should pay attention to some of the things below + +- APP_ENV = You must set this to production so the attendance system will use a server time. But you can set this to local or development so the attendance system will use an inputted time from the request +- XENDIT_SECRET_KEY= Copy your xendit api key. This will be use in the rest API +- XENDIT_CALLBACK_TOKEN= Copy your xendit callback token. This will be use in the rest API + +After you setup the database, run the migration and seeder + +```sh +php artisan migrate +php artisan db:seed +``` + +Run the server and it was ready to use + +```sh +php artisan serve +``` + +## Callback from xendit + +To get callback from xendit you can use http tunneling like ngrok + +## How To Deploy + +After you successfully install it locally, maybe you want to deploy it too. things you should pay attention to when deploying are these.