Skip to content

Postmill
Postmill

getting started

Last edited by Emma
Page history

Getting started

This document will instruct you in setting up Postmill for testing purposes.

(Psst! Instead of setting up PHP and all that stuff yourself, a better way to get started is using Docker.)

Requirements

Make sure you have all the requirements available:

  • PHP >= 7.2 with the curl, gd, iconv, intl, json, mbstring, PDO_PGSQL, tokenizer, and xml extensions.
    • (optional) The amqp extension is required to use RabbitMQ.
  • PostgreSQL >= 9.4
  • Composer
  • Node.js and Yarn

Postmill should be able to run under any Unix environment. It has been tested to work under Linux, macOS, and Windows 10's Linux subsystem. Running directly on Windows may work, but is unsupported.

Clone the repository

Clone the repository somewhere and navigate there with the command line.

$ git clone https://gitlab.com/postmill/Postmill.git
$ cd Postmill

Building the assets

$ yarn install
$ yarn run build-prod

The public/build directory should now be populated.

Setting up the backend

  1. Run composer install.

    If this command fails, it is likely because your system doesn't have the minimum required PHP version or the necessary extensions.

  2. Run vendor/bin/requirements-checker to check your PHP config for any misconfigurations. Fix any errors that arise.

  3. Set up a PostgreSQL database.. You need a username, password, hostname (usually localhost), port (usually 5432), database name, and server version to continue.

  4. Create an empty .env.local file in the project root. At minimum, you must define your database configuration here:

    DATABASE_URL='pgsql://db_user:[email protected]ocalhost:5432/db_name?serverVersion=9.6'

    You can copy other values from .env to override them in your installation.

  5. Run bin/console doctrine:migrations:migrate to load the database schema.

  6. Run php -S 127.0.0.1:8000 -t public to start the application.

  7. Navigate to http://localhost:8000/.

You should be good to go! A good next step would be to learn how to manage admin accounts.