Skip to content

Commit

Permalink
update readme.md & installation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AmdaaRaijen committed May 26, 2023
1 parent 91f4421 commit f73b91b
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 2 deletions.
1 change: 1 addition & 0 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -12,7 +11,7 @@
## Demo

You could try the demo at
https://donasi.insanpeduli.org
https://demo.donazy.org

Email: [email protected]
Password: secret
Expand All @@ -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
Expand Down
42 changes: 42 additions & 0 deletions installation.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit f73b91b

Please sign in to comment.