Production notes

• Make sure to run artisan storage:link to enable profile photos

Vegan Linguists

1. Local development setup
2. Custom configuration options
3. Scheduled jobs
4. Custom commands
5. Receiving emails locally

Local development setup

This project uses Laravel Sail for local development.

Docker

First, you must download Docker.

PHP

In order to install the dependencies required to set up Laravel Sail, you will need PHP installed locally.

• For MacOS users, Homebrew is the recommended way of doing this: Homebrew install php
• For Windows users, you may follow these instructions.
• For Linux users, you should install PHP via your distribution's package manager.

Setup

After you have Docker and PHP installed, navigate to the project directory and run the following:

composer install
./vendor/bin/sail up
./vendor/bin/sail pnpm

Note: If you have node and pnpm installed locally, you can run pnpm from your local machine instead of within the Docker container if you'd like.

Pro tip! Add the following (or something equivalent) to your shell configuration to use Sail more easily:

alias sail="bash vendor/bin/sail"

Development

During development, it's recommended to run the following in parallel:

sail up # starts up Docker container
sail pnpm watch # watches for JS/CSS changes

Custom configuration

This project uses the following custom config files:

• vl.php

Scheduled jobs

This project has the following scheduled jobs:

• SendNewTranslationRequestsEmail: This job sends a weekly email to translators, letting them know about new requests for translations and reviews.
• ResizeNewProfilePhotos: This job resizes new/updated profile photos every hour to keep storage space in check.

Custom commands

This project has no custom commands implemented.

Receiving emails locally

In order to check emails sent locally, visit http://localhost:8025 to access MailHog, which is provided by Laravel Sail