Base README Template

This template should be used as a starting point for all Vegan Hacktivists projects.

# [PROJECT_NAME](https://example.org)

1. [Local development setup](#local-development-setup)
1. [Custom configuration options](#custom-configuration-options)
1. [Scheduled jobs](#scheduled-jobs)
1. [Custom commands](#custom-commands)
1. [Receiving emails locally](#recieving-emails-locally)

## Local development setup

PROJECT_NAME uses [Laravel Sail](https://laravel.com/docs/9.x/sail#main-content) for local development.

### Docker

First, you must download [Docker](https://www.docker.com/).

### 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](https://phptherightway.com/#windows_setup).
* 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:

```bash
composer install
./vendor/bin/sail up
./vendor/bin/sail yarn
```

**Note:** If you have `node` and `yarn` installed locally, you can run `yarn` 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:

```bash
alias sail="bash vendor/bin/sail"
```

### Development

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

```bash
sail up # starts up Docker container
sail yarn dev # watches for JS/CSS changes
```

## Custom configuration options


## Scheduled jobs


## Custom commands


## Receiving emails locally