Skip to content

Commit

Permalink
📝 Update install commands
Browse files Browse the repository at this point in the history
  • Loading branch information
saleem-hadad committed Jan 16, 2022
1 parent 1e3f0d3 commit 3f5314c
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=finance
DB_USERNAME=root
DB_PASSWORD=
DB_PASSWORD=root

BROADCAST_DRIVER=log
CACHE_DRIVER=file
Expand Down
53 changes: 53 additions & 0 deletions .env.sail.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
APP_NAME=FINANCE
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=http://localhost

LOG_CHANNEL=stack
LOG_DEPRECATIONS_CHANNEL=null
LOG_LEVEL=debug

DB_CONNECTION=mysql
DB_HOST=mysql
DB_PORT=3306
DB_DATABASE=finance
DB_USERNAME=sail
DB_PASSWORD=password

BROADCAST_DRIVER=log
CACHE_DRIVER=file
FILESYSTEM_DRIVER=local
QUEUE_CONNECTION=sync
SESSION_DRIVER=file
SESSION_LIFETIME=120

MEMCACHED_HOST=127.0.0.1

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

MAIL_MAILER=smtp
MAIL_HOST=mailhog
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS=null
MAIL_FROM_NAME="${APP_NAME}"

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=
AWS_USE_PATH_STYLE_ENDPOINT=false

PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_APP_CLUSTER=mt1

MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
GRAPHQL_PLAYGROUND_ENABLED=false
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,24 @@ Try the app with [live demo](https://finance-demo.saleem.dev/).
> Docker Installation
```bash
# step 0: clone the app
git clone https://github.com/saleem-hadad/finance && cd finance

# step 1: run migration
docker run --rm \
-u "$(id -u):$(id -g)" \
-v $(pwd):/var/www/html \
-w /var/www/html \
laravelsail/php81-composer:latest \
composer install --ignore-platform-reqs

cp .env.sail.example .env

./vendor/bin/sail up -d

./vendor/bin/sail artisan key:generate

./vendor/bin/sail artisan migrate

# step 2: install command
./vendor/bin/sail artisan finance:install

# step 3: serve the app
./vendor/bin/sail up
```

Once done, visit the app on `http://localhost`
Expand All @@ -49,6 +56,10 @@ If you wish installing the app using normal Laravel environment, make sure you h
# step 0: clone the app
git clone https://github.com/saleem-hadad/finance && cd finance

cp .env.example .env

php artisan key:generate

# step 1: install deps
composer install

Expand Down

0 comments on commit 3f5314c

Please sign in to comment.