Getting Started

Installation

As of Version 2, Sendyak can be installed as a stand-alone application (i.e. including everything you need to run SendYak), or as a package inside an existing Laravel application.

This page covers the stand-alone installation. If you want to install SendYak as a package, then head over to the Package Installation guide.

Requirements

To run SendYak, your environment must meet a few minimum requirements:

  • PHP ≥ 7.3
  • Git
  • Composer
  • MySQL (≥ 5.7) or PostgreSQL (≥ 9.4)

Installing SendYak

Clone The Repository

Clone the repository to your environment, using the following command:

1git clone --depth 1 --branch v2.0.0 https://github.com/cweagans/sendyak.git

Install Dependencies

Once cloned, navigate to the project’s root directory and run composer install to install SendYak and its dependencies.

From here, you can move on to the Configuration & Setup step.

Webserver

You will need to use a webserver (for example, Apache or nginx), in order to host your SendYak installation.

When setting up your webserver, it should be pointed to the public directory in order to correctly serve SendYak.

For example, in nginx:

server {
    listen 80;
    server_name campaigns.example.com;
    root /var/www/campaigns.example.com/public;
}

For more detailed information, see the Laravel deployment documentation.