About

Shop-Local.site; platform & marketplace for local retailers.

Contributing

All development should be done locally using Laravel Herd or any other local development environment.

Pushes to main are automatically deployed on the production server.

Setup

1. Clone the repo
2. Install dependencies with herd composer install
3. Copy .env.example to .env and configure accordingly (APP_URL, DB credentials, and APP_KEY (run herd php artisan key:generate))
4. Install node dependencies with herd php artisan npm:install
5. Initialize a SQlite database for local development with touch storage/database.sqlite
6. Run migrations to initialize your database with herd php artisan migrate
7. Publish the assets with herd php winter:mirror public --relative
8. Set the current version of Winter CMS for cache busting herd php artisan winter:version

Post Update instructions

After pulling changes from the remote repo, always run the following commands to make sure your local copy is up to date with the latest changes:

• herd composer install
• herd php artisan npm:install
• herd php artisan migrate
• herd php artisan winter:mirror public --relative

NOTE: If using the scheduler; ensure that the scheduler is properly configured by following https://wintercms.com/docs/setup/installation#crontab-setup (add * * * * * php /path/to/artisan schedule:run >> /dev/null 2>&1 to the crontab