Mac OS

The following guide is intended for contributors to set-up Paybill locally. If you're interested in self-hosting Paybill, please refer to the Setup section.

To set up and run Paybill on macOS for development, begin by opening your terminal and executing the commands listed below. For a better understanding of Paybill's framework, we advise reviewing our architecture guide before proceeding.

Setting up

Set up the environment

1.1 Install Homebrew
```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
```
1.2 Install Node.js ( version: v18.18.2 ), npm (version: v9.8.1) and pnpm (version: v10.13.1)
```
brew install nvm
export NVM_DIR=~/.nvm
source $(brew --prefix nvm)/nvm.sh
nvm install 18.18.2
nvm use 18.18.2
npm install -g npm@9.8.1
npm install -g pnpm@10.13.1
```
1.3 Install Postgres

tip
Paybill uses a postgres database as the persistent storage for storing data related to users and apps. We do not plan to support other databases such as MySQL.
```
brew install postgresql@13
```
1.4 Fork the repository:

Go to the Paybill GitHub repository, click on the Fork button to create a copy of the repository under your own GitHub account.

1.5 Clone your forked repository:

After forking, clone the forked repository to your local machine using the URL of your forked repo.
```
git clone https://github.com/<your-username>/paybill.git
```
Set up environment variables

Create a .env file by copying .env.example. More information on the variables that can be set is given in the environment variables reference
```
cp .env.example .env
```

Populate the keys in the env file

info

APP_KEY requires a 64 byte key. (If you have openssl installed, run openssl rand -hex 64 to create a 64 byte secure random key)

Example:

 cat .env
 PAYBILL_HOST=http://localhost:8000
 APP_KEY=4229d5774cfe7f60e75d6b3bf3a1dbb054a696b6d21b6d5de7b73291899797a222265e12c0a8e8d844f83ebacdf9a67ec42584edf1c2b23e1e7813f8a3339041
 NODE_ENV=development
 # DATABASE CONFIG
 PG_HOST=localhost
 PG_PORT=5432
 PG_USER=postgres
 PG_PASS=postgres
 PG_DB=paybill_development
 PB_DB=paybill_db
 PB_DB_USER=postgres
 PB_DB_HOST=localhost
 PB_DB_PASS=postgres

Install and build dependencies
```
pnpm install
```
Set up database
```
pnpm --prefix server db:create
```
info
If at any point you need to reset the database, use this command pnpm --prefix server db:reset
Run the client server
```
pnpm start:dev
```
The client will start on the port 4000, you can access the client by visiting: http://localhost:4000

The server will start on the port 8000, you can access the server by visiting: http://localhost:8000
Create login credentials

Visiting http://localhost:4000 should redirect you to the login page, click on the signup link and enter your email. The emails sent by the server in development environment are captured and are opened in your default browser. Click the invitation link in the email preview to setup the account.

Running tests

Test config requires the presence of .env.test file at the root of the project.

To run the unit tests

pnpm --prefix server test

To run e2e tests

pnpm --prefix server test:e2e

To run a specific unit test

pnpm --prefix server test <path-to-file>

Setting up​

Running tests​

Setting up

Running tests