Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.

1. 1

   Clone the repository

   git clone https://github.com/postalserver/postal.git
   cd postal

   Copy
2. 2

   Install the required runtimes

   Ruby 3.4.6

   # needs rbenv: https://github.com/rbenv/rbenv#installation
   rbenv install --skip-existing

   Copy
3. 3

   Start backing services

   Needs: MariaDB

   # needs Docker Engine: https://docs.docker.com/engine/install/
   docker compose -f docker-compose.yml up -d

   Copy

   If you see Cannot connect to the Docker daemon: start Docker Desktop (or the Docker service) first.
4. 4

   Install dependencies

   bundle install

   Copy
5. 5

   Set up the database / app

   bin/rails db:prepare

   Copy
6. 6

   Run it

   bin/dev

   Copy
7. 7

   Run the tests

   bin/rails test

   Copy