magnolia's Introduction

Magnolia Recipes

Magnolia is a recipe website. View the site.

Development

Requirements

Composer
Git
Yarn
Database
Web server with PHP

Setup

# Clone the repo
git clone https://github.com/jlbelanger/magnolia.git
cd magnolia

# Configure the environment settings
cp .env.example .env

# Install dependencies
composer install
yarn install

# Generate key
php artisan key:generate

# Run database migrations
php artisan migrate

# Set permissions
chown -R www-data:www-data storage

# Create account with username "test" and password "password" (or reset existing account password to "password")
php artisan reset-auth

Run

yarn start

Your browser should automatically open https://localhost:3000/

Lint

./vendor/bin/phpcs
yarn lint

Test

./vendor/bin/phpunit

Generate splash screens

npx pwa-asset-generator public/icon.png ./public/assets/img/splash --background "#4b7c9b" --splash-only --type png --portrait-only --padding "20%"

Deployment

Essentially, to set up the repo on the server:

git clone https://github.com/jlbelanger/magnolia.git
cd magnolia
cp .env.example .env
# Then configure the values in .env.
composer install
php artisan key:generate
php artisan migrate
chown -R www-data:www-data storage

For subsequent deploys, push changes to the main branch, then run the following on the server:

cd magnolia
git fetch origin
git pull
composer install
php artisan config:clear

Deploy script

Note: The deploy script included in this repo depends on other scripts that only exist in my private repos. If you want to deploy this repo, you'll have to create your own script.