diff --git a/README.md b/README.md index 62c21ce..eda9333 100755 --- a/README.md +++ b/README.md @@ -3,15 +3,26 @@ This is url shortener application is similar to [bit.ly](http://bit.ly) ## Demo + - Host : https://short.supanadit.com - Email : admin@email.com - Password : 123 +### Generate Short URL + +![Demo 1](demo/demo-1.gif) + +### Generate Protected Short URL + +![Demo 2](demo/demo-2.gif) + ## Requirements + - Laravel 7.0+ - PHP 7.4 ## Quick Start + - `composer install` - create `.env` file - `php artisan key:generate` @@ -20,6 +31,7 @@ This is url shortener application is similar to [bit.ly](http://bit.ly) - `php artisan serve` #### Apache Configuration for Virtual Host + ```apacheconfig DocumentRoot /srv/http/short/public @@ -40,16 +52,22 @@ This is url shortener application is similar to [bit.ly](http://bit.ly) ``` ## Note + If you want to use forgot password feature, you must provide your email and password at `.env` ## Support + [![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/N4N01CIMZ) ## License + Copyright 2020 Supan Adit Pratama -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 +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. +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. diff --git a/demo/demo-1.gif b/demo/demo-1.gif new file mode 100644 index 0000000..6c13dc1 Binary files /dev/null and b/demo/demo-1.gif differ diff --git a/demo/demo-2.gif b/demo/demo-2.gif new file mode 100644 index 0000000..9efff07 Binary files /dev/null and b/demo/demo-2.gif differ