Skip to main content

GitHub Codespaces

Follow the steps below to set up Paybill on GitHub Codespaces. We recommend reading our guide on architecture of Paybill before proceeding.

Open the terminal and run the commands below.

Setting up​

1. Set up the environment​

  1. Install Node.js ( version: v18.18.2 ), npm (version: v9.8.1) and pnpm (version: v10.13.1)
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. Install Postgres
sudo sh -c 'echo "deb [http://apt.postgresql.org/pub/repos/apt](http://apt.postgresql.org/pub/repos/apt) $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'

wget --quiet -O - [https://www.postgresql.org/media/keys/ACCC4CF8.asc](https://www.postgresql.org/media/keys/ACCC4CF8.asc) | sudo apt-key add -

sudo apt-get update

sudo apt-get install postgresql-13 postgresql-contrib-13

To start the postgresql service run the below command:

sudo service postgresql start

If you wish to change the password of the installed postresql service run the below commands:

sudo su

sudo -u postgres psql

\password postgres  

\q

2. Set up environment variables​

Create a .env file by running the command touch .env. More information on the variables that can be set is given in the environment variables reference

For basic set-up you add the below env variables:

PAYBILL_HOST=http://localhost:3000

APP_KEY=

PG_USER=postgres

PG_HOST=localhost

PG_PASS=postgres

PG_DB=paybill_prod

NODE_ENV=production

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)

3. Install and build dependencies​

Make sure node version is set to 18.18.2 before running the below command:

pnpm install

4. Build client and server​

pnpm build

5. Set up database​

pnpm --prefix server db:create

If at any point you need to reset the database, use this command pnpm --prefix server reset

6. Run server​

pnpm start:prod

The client will start on the port 4000, you can access the client by visiting the url created by codespace - https://<url>/

The server will start on the port 8000, you can access the server by visiting the url created by codespace - https://<url>/api/__health_check